Rename digital trait methods try_*

Author: eldruin

src/digital.rs

@@ -9,13 +9,13 @@ pub trait OutputPin {
     ///
     /// *NOTE* the actual electrical state of the pin may not actually be low, e.g. due to external
     /// electrical sources
-    fn set_low(&mut self) -> Result<(), Self::Error>;
+    fn try_set_low(&mut self) -> Result<(), Self::Error>;
 
     /// Drives the pin high
     ///
     /// *NOTE* the actual electrical state of the pin may not actually be high, e.g. due to external
     /// electrical sources
-    fn set_high(&mut self) -> Result<(), Self::Error>;
+    fn try_set_high(&mut self) -> Result<(), Self::Error>;
 }
 
 /// Push-pull output pin that can read its output state
@@ -26,12 +26,12 @@ pub trait StatefulOutputPin: OutputPin {
     /// Is the pin in drive high mode?
     ///
     /// *NOTE* this does *not* read the electrical state of the pin
-    fn is_set_high(&self) -> Result<bool, Self::Error>;
+    fn try_is_set_high(&self) -> Result<bool, Self::Error>;
 
     /// Is the pin in drive low mode?
     ///
     /// *NOTE* this does *not* read the electrical state of the pin
-    fn is_set_low(&self) -> Result<bool, Self::Error>;
+    fn try_is_set_low(&self) -> Result<bool, Self::Error>;
 }
 
 /// Output pin that can be toggled
@@ -48,7 +48,7 @@ pub trait ToggleableOutputPin {
     type Error;
 
     /// Toggle pin output.
-    fn toggle(&mut self) -> Result<(), Self::Error>;
+    fn try_toggle(&mut self) -> Result<(), Self::Error>;
 }
 
 /// If you can read **and** write the output state, a pin is
@@ -57,7 +57,7 @@ pub trait ToggleableOutputPin {
 /// ```
 /// use embedded_hal::digital::{OutputPin, StatefulOutputPin, ToggleableOutputPin};
 /// use embedded_hal::digital::toggleable;
-/// use std::convert::Infallible;
+/// use core::convert::Infallible;
 ///
 /// /// A virtual output pin that exists purely in software
 /// struct MyPin {
@@ -67,21 +67,21 @@ pub trait ToggleableOutputPin {
 /// impl OutputPin for MyPin {
 ///    type Error = Infallible;
 ///
-///    fn set_low(&mut self) -> Result<(), Self::Error> {
+///    fn try_set_low(&mut self) -> Result<(), Self::Error> {
 ///        self.state = false;
 ///        Ok(())
 ///    }
-///    fn set_high(&mut self) -> Result<(), Self::Error> {
+///    fn try_set_high(&mut self) -> Result<(), Self::Error> {
 ///        self.state = true;
 ///        Ok(())
 ///    }
 /// }
 ///
 /// impl StatefulOutputPin for MyPin {
-///    fn is_set_low(&self) -> Result<bool, Self::Error> {
+///    fn try_is_set_low(&self) -> Result<bool, Self::Error> {
 ///        Ok(!self.state)
 ///    }
-///    fn is_set_high(&self) -> Result<bool, Self::Error> {
+///    fn try_is_set_high(&self) -> Result<bool, Self::Error> {
 ///        Ok(self.state)
 ///    }
 /// }
@@ -90,10 +90,10 @@ pub trait ToggleableOutputPin {
 /// impl toggleable::Default for MyPin {}
 ///
 /// let mut pin = MyPin { state: false };
-/// pin.toggle().unwrap();
-/// assert!(pin.is_set_high().unwrap());
-/// pin.toggle().unwrap();
-/// assert!(pin.is_set_low().unwrap());
+/// pin.try_toggle().unwrap();
+/// assert!(pin.try_is_set_high().unwrap());
+/// pin.try_toggle().unwrap();
+/// assert!(pin.try_is_set_low().unwrap());
 /// ```
 #[cfg(feature = "unproven")]
 pub mod toggleable {
@@ -111,11 +111,11 @@ pub mod toggleable {
         type Error = P::Error;
 
         /// Toggle pin output
-        fn toggle(&mut self) -> Result<(), Self::Error> {
-            if self.is_set_low()? {
-                self.set_high()
+        fn try_toggle(&mut self) -> Result<(), Self::Error> {
+            if self.try_is_set_low()? {
+                self.try_set_high()
             } else {
-                self.set_low()
+                self.try_set_low()
             }
         }
     }
@@ -127,8 +127,8 @@ pub trait InputPin {
     type Error;
 
     /// Is the input pin high?
-    fn is_high(&self) -> Result<bool, Self::Error>;
+    fn try_is_high(&self) -> Result<bool, Self::Error>;
 
     /// Is the input pin low?
-    fn is_low(&self) -> Result<bool, Self::Error>;
+    fn try_is_low(&self) -> Result<bool, Self::Error>;
 }