Merge #338

338: digital: enforce all traits have the same Error type. r=therealprof a=Dirbaio

Equivalent of #331 for GPIO traits.

This one is a bit trickier, so it maybe warrants some discussion (this is the reason I've opened everything as separate PR's, sorry for the spam!):

- The bounds on `IoPin` are becoming very cursed, but I *think* they're correct... Is there some HAL out there implementing it, so that I can verify this doesn't break it?
- This forces the "input" and "output" errors to be the same. Perhaps we want to only unify Output and Input separately? In practice I don't think this will be an issue, as structs usually impl only Input or Output but not both (except with IoPin maybe?)

Co-authored-by: Dario Nieuwenhuis <[email protected]>

Author: bors[bot]

CHANGELOG.md

@@ -15,6 +15,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 - `spi`: traits now enforce all impls on the same struct (eg `Transfer` and `Write`) have the same `Error` type. 
 
+### Changed
+- `digital`: traits now enforce all impls on the same struct have the same `Error` type.
+
 ## [v1.0.0-alpha.6] - 2021-11-19
 
 *** This is (also) an alpha release with breaking changes (sorry) ***

src/digital.rs

@@ -2,6 +2,21 @@
 
 use core::{convert::From, ops::Not};
 
+/// GPIO error type trait
+///
+/// This just defines the error type, to be used by the other traits.
+pub trait ErrorType {
+    /// Error type
+    type Error: core::fmt::Debug;
+}
+
+impl<T: ErrorType> ErrorType for &T {
+    type Error = T::Error;
+}
+impl<T: ErrorType> ErrorType for &mut T {
+    type Error = T::Error;
+}
+
 /// Digital output pin state
 ///
 /// Conversion from `bool` and logical negation are also implemented
@@ -45,10 +60,7 @@ pub mod blocking {
     use super::PinState;
 
     /// Single digital push-pull output pin
-    pub trait OutputPin {
-        /// Error type
-        type Error: core::fmt::Debug;
-
+    pub trait OutputPin: super::ErrorType {
         /// Drives the pin low
         ///
         /// *NOTE* the actual electrical state of the pin may not actually be low, e.g. due to external
@@ -74,8 +86,6 @@ pub mod blocking {
     }
 
     impl<T: OutputPin> OutputPin for &mut T {
-        type Error = T::Error;
-
         fn set_low(&mut self) -> Result<(), Self::Error> {
             T::set_low(self)
         }
@@ -113,27 +123,19 @@ pub mod blocking {
     }
 
     /// Output pin that can be toggled
-    pub trait ToggleableOutputPin {
-        /// Error type
-        type Error: core::fmt::Debug;
-
+    pub trait ToggleableOutputPin: super::ErrorType {
         /// Toggle pin output.
         fn toggle(&mut self) -> Result<(), Self::Error>;
     }
 
     impl<T: ToggleableOutputPin> ToggleableOutputPin for &mut T {
-        type Error = T::Error;
-
         fn toggle(&mut self) -> Result<(), Self::Error> {
             T::toggle(self)
         }
     }
 
     /// Single digital input pin
-    pub trait InputPin {
-        /// Error type
-        type Error: core::fmt::Debug;
-
+    pub trait InputPin: super::ErrorType {
         /// Is the input pin high?
         fn is_high(&self) -> Result<bool, Self::Error>;
 
@@ -142,8 +144,6 @@ pub mod blocking {
     }
 
     impl<T: InputPin> InputPin for &T {
-        type Error = T::Error;
-
         fn is_high(&self) -> Result<bool, Self::Error> {
             T::is_high(self)
         }