Add defmt support (#216)

Author: wojciech-graj

.github/workflows/rust.yml

@@ -11,7 +11,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         rust:
-        - 1.55.0 # approximate MSRV is Stable -30
+        - 1.60.0 # approximate MSRV is Stable -30
         - stable
         - beta
         - nightly
@@ -28,11 +28,11 @@ jobs:
         toolchain: ${{ matrix.rust }}
     # On MSRV some dev-dependencies don't build so we can't run tests.
     - name: Check MSRV
-      if: matrix.rust == '1.55.0'
+      if: matrix.rust == '1.60.0'
       run: |
         cargo check --features=alloc,std,grab_spare_slice
     - name: Test non nightly
-      if: matrix.rust != '1.55.0' && matrix.rust != 'nightly'
+      if: matrix.rust != '1.60.0' && matrix.rust != 'nightly'
       run: |
         cargo test --features=alloc,std,grab_spare_slice,latest_stable_rust
     - name: Test on Nightly with All Features

Cargo.toml

@@ -20,6 +20,8 @@ arbitrary = { version = "1", optional = true }
 borsh = { version = "1.2.0", optional = true, default-features = false }
 # Implements the trait `Array` for `GenericArray` struct.
 generic-array = { version = "1.1.1", optional = true, default-features = false }
+# Provides `Format` implementations
+defmt = { version = "1.0", optional = true }
 
 
 [features]
@@ -79,12 +81,15 @@ experimental_write_impl = []
 real_blackbox = ["criterion/real_blackbox"]
 
 [package.metadata.docs.rs]
-features = ["alloc", "std", "grab_spare_slice", "latest_stable_rust", "serde", "borsh"]
+features = ["alloc", "std", "grab_spare_slice", "latest_stable_rust", "serde", "borsh", "defmt"]
 rustdoc-args = ["--cfg","docs_rs"]
 
 [package.metadata.playground]
 features = ["alloc", "std", "grab_spare_slice", "latest_stable_rust", "serde", "borsh"]
 
+[profile.dev]
+lto = "thin"
+
 [profile.bench]
 debug = 2
 

src/arrayvec.rs

@@ -1440,6 +1440,7 @@ impl<A: Array> From<A> for ArrayVec<A> {
 /// The error type returned when a conversion from a slice to an [`ArrayVec`]
 /// fails.
 #[derive(Debug, Copy, Clone)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct TryFromSliceError(());
 
 impl core::fmt::Display for TryFromSliceError {
@@ -1594,6 +1595,17 @@ where
   }
 }
 
+#[cfg(feature = "defmt")]
+#[cfg_attr(docs_rs, doc(cfg(feature = "defmt")))]
+impl<A: Array> defmt::Format for ArrayVecIterator<A>
+where
+  A::Item: defmt::Format,
+{
+  fn format(&self, fmt: defmt::Formatter<'_>) {
+    defmt::write!(fmt, "ArrayVecIterator({:?})", self.as_slice())
+  }
+}
+
 impl<A: Array> IntoIterator for ArrayVec<A> {
   type Item = A::Item;
   type IntoIter = ArrayVecIterator<A>;
@@ -1734,6 +1746,17 @@ where
   }
 }
 
+#[cfg(feature = "defmt")]
+#[cfg_attr(docs_rs, doc(cfg(feature = "defmt")))]
+impl<A: Array> defmt::Format for ArrayVec<A>
+where
+  A::Item: defmt::Format,
+{
+  fn format(&self, fmt: defmt::Formatter<'_>) {
+    defmt::Format::format(self.as_slice(), fmt)
+  }
+}
+
 impl<A: Array> Display for ArrayVec<A>
 where
   A::Item: Display,

src/lib.rs

@@ -52,6 +52,8 @@
 //! * `borsh` provides a `BorshSerialize` and `BorshDeserialize` implementation
 //!   for [`TinyVec`] and [`ArrayVec`] types, provided the inner item also has
 //!   an implementation.
+//! * `defmt` provides a `Format` implementation for all types, provided the
+//!   inner item also has an implementation.
 //!
 //! ## API
 //! The general goal of the crate is that, as much as possible, the vecs here

src/slicevec.rs

@@ -924,6 +924,17 @@ where
   }
 }
 
+#[cfg(feature = "defmt")]
+#[cfg_attr(docs_rs, doc(cfg(feature = "defmt")))]
+impl<'s, T> defmt::Format for SliceVec<'s, T>
+where
+  T: defmt::Format,
+{
+  fn format(&self, fmt: defmt::Formatter<'_>) {
+    defmt::Format::format(self.as_slice(), fmt)
+  }
+}
+
 impl<'s, T> Display for SliceVec<'s, T>
 where
   T: Display,

src/tinyvec.rs

@@ -1553,6 +1553,17 @@ where
   }
 }
 
+#[cfg(feature = "defmt")]
+#[cfg_attr(docs_rs, doc(cfg(feature = "defmt")))]
+impl<A: Array> defmt::Format for TinyVecIterator<A>
+where
+  A::Item: defmt::Format,
+{
+  fn format(&self, fmt: defmt::Formatter<'_>) {
+    defmt::write!(fmt, "TinyVecIterator({:?})", self.as_slice())
+  }
+}
+
 impl<A: Array> IntoIterator for TinyVec<A> {
   type Item = A::Item;
   type IntoIter = TinyVecIterator<A>;
@@ -1680,6 +1691,17 @@ where
   }
 }
 
+#[cfg(feature = "defmt")]
+#[cfg_attr(docs_rs, doc(cfg(feature = "defmt")))]
+impl<A: Array> defmt::Format for TinyVec<A>
+where
+  A::Item: defmt::Format,
+{
+  fn format(&self, fmt: defmt::Formatter<'_>) {
+    defmt::Format::format(self.as_slice(), fmt)
+  }
+}
+
 impl<A: Array> Display for TinyVec<A>
 where
   A::Item: Display,