Merge #308

308: Require all associated error types to implement `core::fmt::Debug` r=eldruin a=GrantM11235



Co-authored-by: Grant Miller <[email protected]>

Author: bors[bot]

CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Removed `prelude` to avoid method name conflicts between different flavors (blocking, nb) of the same trait. Traits must now be manually imported.
 - Removed the various `Default` marker traits.
 - Removed `&[W]` returned slice in `spi::blocking::Transfer`.
+- Require all associated error types to implement `core::fmt::Debug`.
 
 ### Removed
 - Removed random number generation (`rng`) traits in favor of [rand_core](https://crates.io/crates/rand_core).

src/adc.rs

@@ -84,7 +84,7 @@ pub mod nb {
     /// ```
     pub trait OneShot<ADC, Word, Pin: Channel<ADC>> {
         /// Error type returned by ADC methods
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Request that the ADC begin a conversion on the specified pin
         ///

src/capture.rs

@@ -59,7 +59,7 @@ pub trait Capture {
     ///
     /// - *overcapture*, the previous capture value was overwritten because it
     ///   was not read in a timely manner
-    type Error;
+    type Error: core::fmt::Debug;
 
     /// Enumeration of channels that can be used with this `Capture` interface
     ///

src/delay.rs

@@ -15,7 +15,7 @@ pub mod blocking {
     /// implement this trait for different types of `UXX`.
     pub trait DelayMs<UXX> {
         /// Enumeration of `DelayMs` errors
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Pauses execution for `ms` milliseconds
         fn delay_ms(&mut self, ms: UXX) -> Result<(), Self::Error>;
@@ -27,7 +27,7 @@ pub mod blocking {
     /// implement this trait for different types of `UXX`.
     pub trait DelayUs<UXX> {
         /// Enumeration of `DelayMs` errors
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Pauses execution for `us` microseconds
         fn delay_us(&mut self, us: UXX) -> Result<(), Self::Error>;

src/digital.rs

@@ -51,7 +51,7 @@ pub mod blocking {
     /// Single digital push-pull output pin
     pub trait OutputPin {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Drives the pin low
         ///
@@ -98,7 +98,7 @@ pub mod blocking {
     /// implemented. Otherwise, implement this using hardware mechanisms.
     pub trait ToggleableOutputPin {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Toggle pin output.
         fn toggle(&mut self) -> Result<(), Self::Error>;
@@ -107,7 +107,7 @@ pub mod blocking {
     /// Single digital input pin
     pub trait InputPin {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Is the input pin high?
         fn is_high(&self) -> Result<bool, Self::Error>;
@@ -125,7 +125,7 @@ pub mod blocking {
     /// use core::time::Duration;
     /// use embedded_hal::digital::blocking::{IoPin, InputPin, OutputPin};
     ///
-    /// pub fn ping_and_read<TInputPin, TOutputPin, TError>(
+    /// pub fn ping_and_read<TInputPin, TOutputPin, TError: core::fmt::Debug>(
     ///     mut pin: TOutputPin, delay_fn: &dyn Fn(Duration) -> ()) -> Result<bool, TError>
     /// where
     ///     TInputPin : InputPin<Error = TError> + IoPin<TInputPin, TOutputPin, Error = TError>,
@@ -148,7 +148,7 @@ pub mod blocking {
         TOutput: OutputPin + IoPin<TInput, TOutput>,
     {
         /// Error type.
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Tries to convert this pin to input mode.
         ///

src/fmt.rs

@@ -3,7 +3,7 @@
 //! TODO write example of usage
 use core::fmt::{Result, Write};
 
-impl<Word, Error> Write for dyn crate::serial::nb::Write<Word, Error = Error> + '_
+impl<Word, Error: core::fmt::Debug> Write for dyn crate::serial::nb::Write<Word, Error = Error> + '_
 where
     Word: From<u8>,
 {

src/i2c.rs

@@ -63,7 +63,7 @@
 //!     i2c: I2C,
 //! }
 //!
-//! impl<I2C, E> TemperatureSensorDriver<I2C>
+//! impl<I2C, E: core::fmt::Debug> TemperatureSensorDriver<I2C>
 //! where
 //!     I2C: WriteRead<Error = E>,
 //! {
@@ -86,7 +86,7 @@
 //!     i2c: I2C,
 //! }
 //!
-//! impl<I2C, E> TemperatureSensorDriver<I2C>
+//! impl<I2C, E: core::fmt::Debug> TemperatureSensorDriver<I2C>
 //! where
 //!     I2C: WriteRead<TenBitAddress, Error = E>,
 //! {
@@ -124,7 +124,7 @@ pub mod blocking {
     /// Blocking read
     pub trait Read<A: AddressMode = SevenBitAddress> {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Reads enough bytes from slave with `address` to fill `buffer`
         ///
@@ -150,7 +150,7 @@ pub mod blocking {
     /// Blocking write
     pub trait Write<A: AddressMode = SevenBitAddress> {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Writes bytes to slave with address `address`
         ///
@@ -174,7 +174,7 @@ pub mod blocking {
     /// Blocking write (iterator version)
     pub trait WriteIter<A: AddressMode = SevenBitAddress> {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Writes bytes to slave with address `address`
         ///
@@ -189,7 +189,7 @@ pub mod blocking {
     /// Blocking write + read
     pub trait WriteRead<A: AddressMode = SevenBitAddress> {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Writes bytes to slave with address `address` and then reads enough bytes to fill `buffer` *in a
         /// single transaction*
@@ -224,7 +224,7 @@ pub mod blocking {
     /// Blocking write (iterator version) + read
     pub trait WriteIterRead<A: AddressMode = SevenBitAddress> {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Writes bytes to slave with address `address` and then reads enough bytes to fill `buffer` *in a
         /// single transaction*
@@ -258,7 +258,7 @@ pub mod blocking {
     /// This allows combining operations within an I2C transaction.
     pub trait Transactional<A: AddressMode = SevenBitAddress> {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Execute the provided operations on the I2C bus.
         ///
@@ -285,7 +285,7 @@ pub mod blocking {
     /// This allows combining operation within an I2C transaction.
     pub trait TransactionalIter<A: AddressMode = SevenBitAddress> {
         /// Error type
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Execute the provided operations on the I2C bus (iterator version).
         ///

src/lib.rs

@@ -77,7 +77,7 @@
 //! /// A serial interface
 //! pub trait Serial {
 //!     /// Error type associated to this serial interface
-//!     type Error;
+//!     type Error: core::fmt::Debug;
 //!
 //!     /// Reads a single byte
 //!     fn read(&mut self) -> nb::Result<u8, Self::Error>;
@@ -144,6 +144,7 @@
 //! pub type Serial1 = Serial<USART1>;
 //!
 //! /// Serial interface error
+//! #[derive(Debug)]
 //! pub enum Error {
 //!     /// Buffer overrun
 //!     Overrun,

src/pwm.rs

@@ -54,7 +54,7 @@ pub mod blocking {
     // PWM channels. Here a certain number of channels are multiplexed in a single implementer.
     pub trait Pwm {
         /// Enumeration of `Pwm` errors
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Enumeration of channels that can be used with this `Pwm` interface
         ///
@@ -107,7 +107,7 @@ pub mod blocking {
     /// See `Pwm` for details
     pub trait PwmPin {
         /// Enumeration of `PwmPin` errors
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// Type for the `duty` methods
         ///

src/qei.rs

@@ -70,7 +70,7 @@ pub mod blocking {
     // reference implementation
     pub trait Qei {
         /// Enumeration of `Qei` errors
-        type Error;
+        type Error: core::fmt::Debug;
 
         /// The type of the value returned by `count`
         type Count;