Experimental support for Facet

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Implement scalar `Point` operations (#71).
 - Implement `Mul<Vector{2,3}>` and `Mul<Point{2,3}>` for `Matrix{3,4}`.
 - Implemented all the methods that exist on `Box2` for `Box3` as well.
+- Experimental support for [`facet`](https://docs.rs/facet/latest/facet/).
 
 ### Breaking changes
 

Cargo.toml

@@ -31,6 +31,8 @@ glam = { version = "0.30.0", default-features = false, features = [
 bytemuck = { version = "^1.8", default-features = false }
 num-traits = { version = "^0.2.19", default-features = false }
 approx = "^0.5"
+facet = { version = "0.18.4", optional = true, default-features = false }
+facet-derive = { version = "0.18.4", optional = true }
 
 [dependencies.serde]
 version = "^1.0"
@@ -62,6 +64,7 @@ std = ["glam/std", "num-traits/std"]
 scalar-math = ["glam/scalar-math"]
 serde = ["dep:serde", "glam/serde"]
 core-simd = ["glam/core-simd"]
+facet = ["dep:facet", "dep:facet-derive"]
 
 # Enable conversions to `mint` types
 mint = ["dep:mint", "glam/mint"]

README.md

@@ -72,6 +72,10 @@ let vector_raw: &glam::Vec4 = glamour::Transparent::peel_ref(&vector);
   compatible type declaration in a WIT world, but limitations apply: Due to the
   way the `wasmtime` derive macros work, only plain scalar units can be used (so
   `Vector4<f32>` is supported, but not `Vector4<MyFloatUnit>`).
+- `facet`: **(Experimental)** Adds support for
+  [`facet`](https://docs.rs/facet/latest/facet/) to all types.
+
+[`wasmtime::component::bindgen!()`]: https://docs.rs/wasmtime/latest/wasmtime/component/macro.bindgen.html
 
 # Advantages
 

src/angle.rs

@@ -24,6 +24,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 pub struct Angle<U: Scalar = f32> {
     /// Angle in radians.
     pub radians: U,
@@ -152,7 +153,7 @@
 
 impl<T> Unit for Angle<T>
 where
-    T: Scalar + AngleConsts,
+    T: Scalar + AngleConsts + crate::traits::marker::Facet<'static>,
 {
     type Scalar = T;
 }

src/box.rs

@@ -21,6 +21,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 #[repr(C)]
 pub struct Box2<U: Unit = f32> {
     /// Lower bound of the box.
@@ -47,6 +48,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 #[repr(C)]
 pub struct Box3<U: Unit = f32> {
     /// Lower bound of the box.

src/matrix.rs

@@ -25,6 +25,7 @@
 /// Alignment: Always 16-byte aligned.
 #[derive(Clone, Copy, PartialEq, Eq)]
 #[repr(C)]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 // #[cfg_attr(feature = "wasmtime", derive(wasmtime::component::ComponentType))]
 // #[cfg_attr(feature = "wasmtime", component(record))]
 pub struct Matrix2<T: Scalar>(Vector4<T>);
@@ -56,6 +57,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 pub struct Matrix3<U: Scalar> {
     #[cfg_attr(
         all(not(target_arch = "wasm32"), feature = "wasmtime"),
@@ -101,6 +103,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 pub struct Matrix4<U: Scalar> {
     #[cfg_attr(
         all(not(target_arch = "wasm32"), feature = "wasmtime"),

src/point.rs

@@ -34,6 +34,7 @@
     component(record)
 )]
 #[repr(C)]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 pub struct Point2<U: Unit = f32> {
     /// X coordinate
     pub x: U::Scalar,
@@ -66,6 +67,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 #[repr(C)]
 pub struct Point3<U: Unit = f32> {
     /// X coordinate

src/rect.rs

@@ -22,6 +22,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 #[repr(C)]
 pub struct Rect<U: Unit = f32> {
     /// Lower bound of the rect.

src/size.rs

@@ -21,6 +21,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 #[repr(C)]
 pub struct Size2<U: Unit = f32> {
     /// Width
@@ -51,6 +52,7 @@
     component(record)
 )]
 #[repr(C)]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 pub struct Size3<U: Unit = f32> {
     /// Width
     pub width: U::Scalar,

src/traits/marker.rs

@@ -61,3 +61,13 @@ impl<T> WasmComponentType for T where
 }
 #[cfg(any(target_arch = "wasm32", not(feature = "wasmtime")))]
 impl<T> WasmComponentType for T {}
+
+#[cfg(feature = "facet")]
+#[doc(no_inline)]
+pub use facet::Facet;
+
+/// Marker trait for when `#[cfg(feature = "facet")]` is not enabled.
+#[cfg(not(feature = "facet"))]
+pub trait Facet<'a> {}
+#[cfg(not(feature = "facet"))]
+impl<'a, T: 'a> Facet<'a> for T {}

src/transform.rs

@@ -21,6 +21,7 @@
 /// This is a strongly typed wrapper around a [`Matrix3`], where that matrix
 /// describes how to map between units.
 #[repr(transparent)]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 pub struct Transform2<Src: Unit, Dst: Unit> {
     /// Underlying matrix.
     pub matrix: Matrix3<Src::Scalar>,
@@ -32,6 +33,7 @@
 /// This is a strongly typed wrapper around a [`Matrix4`], where that matrix
 /// describes how to map between units.
 #[repr(transparent)]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 pub struct Transform3<Src: Unit, Dst: Unit> {
     /// Underlying matrix.
     pub matrix: Matrix4<Src::Scalar>,

src/unit.rs

@@ -32,7 +32,7 @@ use super::Scalar;
 pub trait Unit: 'static {
     /// One of the vector component types of glam: `f32`, `f64`, `i32`, or
     /// `u32`.
-    type Scalar: Scalar;
+    type Scalar: Scalar + crate::traits::marker::Facet<'static>;
 }
 
 /// Convenience trait implemented for all [`Unit`]s with an integer scalar type.

src/vector.rs

@@ -60,6 +60,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 pub struct Vector2<U: Unit = f32> {
     /// X coordinate
     pub x: U::Scalar,
@@ -92,6 +93,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 #[repr(C)]
 pub struct Vector3<U: Unit = f32> {
     /// X coordinate
@@ -136,6 +138,7 @@
     all(not(target_arch = "wasm32"), feature = "wasmtime"),
     component(record)
 )]
+#[cfg_attr(feature = "facet", derive(facet_derive::Facet))]
 pub struct Vector4<U: Unit = f32> {
     /// X coordinate
     pub x: U::Scalar,
@@ -412,6 +415,7 @@
 #[cfg(test)]
 mod tests {
     use approx::{RelativeEq, UlpsEq, assert_abs_diff_eq};
+    use core::ptr;
 
     use crate::{Angle, AngleConsts, vec2, vec3, vec4, vector};
 
@@ -757,6 +761,7 @@
     }
 
     #[test]
+    #[allow(clippy::many_single_char_names)]
     fn scaling_by_scalar() {
         // Test that vector types can be multiplied/divided by their
         // (unsplatted) scalar. This doesn't work in generic code, but it should
@@ -1156,29 +1161,19 @@
         let v3 = Vector3::<f32>::new(1.0, 2.0, 3.0);
         let v4 = Vector4::<f32>::new(1.0, 2.0, 3.0, 4.0);
 
-        assert_eq!(v2.as_raw() as *const _, peel_ref(&v2) as *const _);
+        assert!(ptr::eq(v2.as_raw(), peel_ref(&v2)));
         assert_eq!(v2.to_raw(), glam::Vec2::new(1.0, 2.0));
         assert_eq!(v2, Vector2::from_raw(glam::Vec2::new(1.0, 2.0)));
 
-        assert_eq!(v3.as_raw() as *const _, peel_ref(&v3) as *const _);
+        assert!(ptr::eq(v3.as_raw(), peel_ref(&v3)));
         assert_eq!(v3.to_raw(), glam::Vec3::new(1.0, 2.0, 3.0));
         assert_eq!(v3, Vector3::from_raw(glam::Vec3::new(1.0, 2.0, 3.0)));
 
-        assert_eq!(v4.as_raw() as *const _, peel_ref(&v4) as *const _);
+        assert!(ptr::eq(v4.as_raw(), peel_ref(&v4)));
         assert_eq!(v4.to_raw(), glam::Vec4::new(1.0, 2.0, 3.0, 4.0));
         assert_eq!(v4, Vector4::from_raw(glam::Vec4::new(1.0, 2.0, 3.0, 4.0)));
     }
 
-    fn hash_one<T: core::hash::Hash, H: core::hash::BuildHasher>(
-        build_hasher: &H,
-        value: T,
-    ) -> u64 {
-        use core::hash::Hasher;
-        let mut h = build_hasher.build_hasher();
-        value.hash(&mut h);
-        h.finish()
-    }
-
     #[derive(Default)]
     struct PoorHasher(u64);
 
@@ -1196,9 +1191,10 @@
 
     #[test]
     fn hash_equality() {
+        use core::hash::BuildHasher;
         let hasher = core::hash::BuildHasherDefault::<PoorHasher>::default();
-        let h1 = hash_one(&hasher, Vector2::<i32> { x: 123, y: 456 });
-        let h2 = hash_one(&hasher, glam::IVec2::new(123, 456));
+        let h1 = hasher.hash_one(Vector2::<i32> { x: 123, y: 456 });
+        let h2 = hasher.hash_one(glam::IVec2::new(123, 456));
         assert_eq!(h1, h2);
     }