Add defmt::Format bound to error types

Author: JalonWong

embedded-can/src/blocking.rs

@@ -6,6 +6,10 @@ pub trait Can {
     type Frame: crate::Frame;
 
     /// Associated error type.
+    #[cfg(feature = "defmt")]
+    type Error: crate::Error + defmt::Format;
+    /// Associated error type.
+    #[cfg(not(feature = "defmt"))]
     type Error: crate::Error;
 
     /// Puts a frame in the transmit buffer. Blocks until space is available in

embedded-can/src/nb.rs

@@ -6,6 +6,10 @@ pub trait Can {
     type Frame: crate::Frame;
 
     /// Associated error type.
+    #[cfg(feature = "defmt")]
+    type Error: crate::Error + defmt::Format;
+    /// Associated error type.
+    #[cfg(not(feature = "defmt"))]
     type Error: crate::Error;
 
     /// Puts a frame in the transmit buffer to be sent on the bus.

embedded-hal-bus/src/i2c/atomic.rs

@@ -1,5 +1,7 @@
 use embedded_hal::i2c::{Error, ErrorKind, ErrorType, I2c};
 
+#[cfg(feature = "defmt-03")]
+use crate::defmt;
 use crate::util::AtomicCell;
 
 /// Atomics-based shared bus [`I2c`] implementation.
@@ -30,6 +32,8 @@ use crate::util::AtomicCell;
 /// use embedded_hal_bus::i2c;
 /// use embedded_hal_bus::util::AtomicCell;
 /// # use embedded_hal::i2c::{self as hali2c, SevenBitAddress, TenBitAddress, I2c, Operation, ErrorKind};
+/// # #[cfg(feature = "defmt-03")]
+/// # use embedded_hal::defmt;
 /// # pub struct Sensor<I2C> {
 /// #     i2c: I2C,
 /// #     address: u8,
@@ -42,6 +46,7 @@ use crate::util::AtomicCell;
 /// # type PressureSensor<I2C> = Sensor<I2C>;
 /// # type TemperatureSensor<I2C> = Sensor<I2C>;
 /// # pub struct I2c0;
+/// # #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
 /// # #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 /// # pub enum Error { }
 /// # impl hali2c::Error for Error {
@@ -80,6 +85,7 @@ pub struct AtomicDevice<'a, T> {
     bus: &'a AtomicCell<T>,
 }
 
+#[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
 #[derive(Debug, Copy, Clone)]
 /// Wrapper type for errors originating from the atomically-checked I2C bus manager.
 pub enum AtomicError<T: Error> {

embedded-hal-bus/src/i2c/refcell.rs

@@ -17,6 +17,8 @@ use embedded_hal::i2c::{ErrorType, I2c};
 /// use embedded_hal_bus::i2c;
 /// use core::cell::RefCell;
 /// # use embedded_hal::i2c::{self as hali2c, SevenBitAddress, TenBitAddress, I2c, Operation, ErrorKind};
+/// # #[cfg(feature = "defmt-03")]
+/// # use embedded_hal::defmt;
 /// # pub struct Sensor<I2C> {
 /// #     i2c: I2C,
 /// #     address: u8,
@@ -29,6 +31,7 @@ use embedded_hal::i2c::{ErrorType, I2c};
 /// # type PressureSensor<I2C> = Sensor<I2C>;
 /// # type TemperatureSensor<I2C> = Sensor<I2C>;
 /// # pub struct I2c0;
+/// # #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
 /// # #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 /// # pub enum Error { }
 /// # impl hali2c::Error for Error {

embedded-hal-bus/src/spi/atomic.rs

@@ -3,6 +3,8 @@ use embedded_hal::digital::OutputPin;
 use embedded_hal::spi::{Error, ErrorKind, ErrorType, Operation, SpiBus, SpiDevice};
 
 use super::DeviceError;
+#[cfg(feature = "defmt-03")]
+use crate::defmt;
 use crate::spi::shared::transaction;
 use crate::util::AtomicCell;
 
@@ -36,12 +38,13 @@ pub struct AtomicDevice<'a, BUS, CS, D> {
     delay: D,
 }
 
-#[derive(Debug, Copy, Clone)]
 /// Wrapper type for errors returned by [`AtomicDevice`].
+#[derive(Debug, Copy, Clone)]
 #[cfg_attr(
     docsrs,
     doc(cfg(any(feature = "portable-atomic", target_has_atomic = "8")))
 )]
+#[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
 pub enum AtomicError<T: Error> {
     /// This error is returned if the SPI bus was already in use when an operation was attempted,
     /// which indicates that the driver requirements are not being met with regard to

embedded-hal/src/digital.rs

@@ -59,7 +59,11 @@ impl core::fmt::Display for ErrorKind {
 ///
 /// This just defines the error type, to be used by the other traits.
 pub trait ErrorType {
-    /// Error type
+    /// Error type.
+    #[cfg(feature = "defmt-03")]
+    type Error: Error + defmt::Format;
+    /// Error type.
+    #[cfg(not(feature = "defmt-03"))]
     type Error: Error;
 }
 

embedded-hal/src/i2c.rs

@@ -125,10 +125,13 @@
 //!
 //! ```
 //! use embedded_hal::i2c::{self, SevenBitAddress, TenBitAddress, I2c, Operation};
+//! #[cfg(feature = "defmt-03")]
+//! use embedded_hal::defmt;
 //!
 //! /// I2C0 hardware peripheral which supports both 7-bit and 10-bit addressing.
 //! pub struct I2c0;
 //!
+//! #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
 //! #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 //! pub enum Error {
 //!     // ...
@@ -265,7 +268,11 @@ impl core::fmt::Display for NoAcknowledgeSource {
 ///
 /// This just defines the error type, to be used by the other traits.
 pub trait ErrorType {
-    /// Error type
+    /// Error type.
+    #[cfg(feature = "defmt-03")]
+    type Error: Error + defmt::Format;
+    /// Error type.
+    #[cfg(not(feature = "defmt-03"))]
     type Error: Error;
 }
 

embedded-hal/src/lib.rs

@@ -18,4 +18,4 @@ mod private {
 
 // needed to prevent defmt macros from breaking, since they emit code that does `defmt::blahblah`.
 #[cfg(feature = "defmt-03")]
-use defmt_03 as defmt;
+pub use defmt_03 as defmt;

embedded-hal/src/pwm.rs

@@ -58,7 +58,11 @@ impl core::fmt::Display for ErrorKind {
 ///
 /// This just defines the error type, to be used by the other traits.
 pub trait ErrorType {
-    /// Error type
+    /// Error type.
+    #[cfg(feature = "defmt-03")]
+    type Error: Error + defmt::Format;
+    /// Error type.
+    #[cfg(not(feature = "defmt-03"))]
     type Error: Error;
 }
 

embedded-hal/src/spi.rs

@@ -307,6 +307,10 @@ impl core::fmt::Display for ErrorKind {
 /// This just defines the error type, to be used by the other SPI traits.
 pub trait ErrorType {
     /// Error type.
+    #[cfg(feature = "defmt-03")]
+    type Error: Error + defmt::Format;
+    /// Error type.
+    #[cfg(not(feature = "defmt-03"))]
     type Error: Error;
 }