Auto merge of #20 - hannobraun:mut-self, r=japaric

Change traits to take `&mut self`, where appropriate

This pull request supersedes #16, which seems stalled. It is based on #19. Only the last two commits are actually relevant to this pull request itself. I suggest merging #19 first, then I can rebase this one.

Author: homunkulus

src/lib.rs

@@ -85,16 +85,16 @@
 //!     fn get_timeout(&self) -> Self::Time;
 //!
 //!     /// Pauses the timer
-//!     fn pause(&self);
+//!     fn pause(&mut self);
 //!
 //!     /// Restarts the timer count
-//!     fn restart(&self);
+//!     fn restart(&mut self);
 //!
 //!     /// Resumes the timer count
-//!     fn resume(&self);
+//!     fn resume(&mut self);
 //!
 //!     /// Sets a new timeout
-//!     fn set_timeout<T>(&self, ticks: T) where T: Into<Self::Time>;
+//!     fn set_timeout<T>(&mut self, ticks: T) where T: Into<Self::Time>;
 //!
 //!     /// "waits" until the timer times out
 //!     fn wait(&self) -> nb::Result<(), !>;
@@ -146,7 +146,7 @@
 //! {
 //!     type Error = Error;
 //!
-//!     fn read(&self) -> nb::Result<u8, Error> {
+//!     fn read(&mut self) -> nb::Result<u8, Error> {
 //!         // read the status register
 //!         let sr = self.0.sr.read();
 //!
@@ -172,7 +172,7 @@
 //! {
 //!     type Error = Error;
 //!
-//!     fn write(&self, byte: u8) -> nb::Result<(), Error> {
+//!     fn write(&mut self, byte: u8) -> nb::Result<(), Error> {
 //!         // Very similar to the above implementation
 //!         Ok(())
 //!     }
@@ -203,7 +203,7 @@
 //! impl hal::serial::Read<u8> for Serial1 {
 //!     type Error = !;
 //!
-//!     fn read(&self) -> Result<u8, nb::Error<Self::Error>> {
+//!     fn read(&mut self) -> Result<u8, nb::Error<Self::Error>> {
 //!         hal::serial::Read::read(&Serial(&*USART1.lock()))
 //!     }
 //! }
@@ -419,7 +419,7 @@
 //!
 //! use hal::prelude::*;
 //!
-//! fn write_all<S>(serial: &S, buffer: &[u8]) -> Result<(), S::Error>
+//! fn write_all<S>(serial: &mut S, buffer: &[u8]) -> Result<(), S::Error>
 //! where
 //!     S: hal::serial::Write<u8>
 //! {
@@ -446,8 +446,8 @@
 //! }
 //!
 //! fn read_with_timeout<S, T>(
-//!     serial: &S,
-//!     timer: &T,
+//!     serial: &mut S,
+//!     timer: &mut T,
 //!     timeout: T::Time,
 //! ) -> Result<u8, Error<S::Error>>
 //! where
@@ -519,7 +519,7 @@
 //!
 //! use hal::prelude::*;
 //!
-//! fn flush<S>(serial: &S, cb: &mut CircularBuffer) -> Result<(), S::Error>
+//! fn flush<S>(serial: &mut S, cb: &mut CircularBuffer) -> Result<(), S::Error>
 //! where
 //!     S: hal::serial::Write<u8>,
 //! {
@@ -565,7 +565,7 @@
 //!     let serial = SERIAL.lock();
 //!     let buffer = BUFFER.lock();
 //!
-//!     flush(&serial, &mut buffer).unwrap();
+//!     flush(&mut serial, &mut buffer).unwrap();
 //! }
 //! ```
 //!
@@ -660,21 +660,21 @@ pub trait Capture {
     /// NOTE that you must multiply the returned value by the *resolution* of
     /// this `Capture` interface to get a human time unit (e.g. seconds)
     fn capture(
-        &self,
+        &mut self,
         channel: Self::Channel,
     ) -> nb::Result<Self::Capture, Self::Error>;
 
     /// Disables a capture `channel`
-    fn disable(&self, channel: Self::Channel);
+    fn disable(&mut self, channel: Self::Channel);
 
     /// Enables a capture `channel`
-    fn enable(&self, channel: Self::Channel);
+    fn enable(&mut self, channel: Self::Channel);
 
     /// Returns the current resolution
     fn get_resolution(&self) -> Self::Time;
 
     /// Sets the resolution of the capture timer
-    fn set_resolution<R>(&self, resolution: R)
+    fn set_resolution<R>(&mut self, resolution: R)
     where
         R: Into<Self::Time>;
 }
@@ -715,10 +715,10 @@ pub trait Pwm {
     type Duty;
 
     /// Disables a PWM `channel`
-    fn disable(&self, channel: Self::Channel);
+    fn disable(&mut self, channel: Self::Channel);
 
     /// Enables a PWM `channel`
-    fn enable(&self, channel: Self::Channel);
+    fn enable(&mut self, channel: Self::Channel);
 
     /// Returns the current PWM period
     fn get_period(&self) -> Self::Time;
@@ -730,10 +730,10 @@ pub trait Pwm {
     fn get_max_duty(&self) -> Self::Duty;
 
     /// Sets a new duty cycle
-    fn set_duty(&self, channel: Self::Channel, duty: Self::Duty);
+    fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty);
 
     /// Sets a new PWM period
-    fn set_period<P>(&self, period: P)
+    fn set_period<P>(&mut self, period: P)
     where
         P: Into<Self::Time>;
 }
@@ -805,10 +805,10 @@ pub trait Spi<Word> {
     ///
     /// **NOTE** A word must be sent to the slave before attempting to call this
     /// method.
-    fn read(&self) -> nb::Result<Word, Self::Error>;
+    fn read(&mut self) -> nb::Result<Word, Self::Error>;
 
     /// Sends a word to the slave
-    fn send(&self, word: Word) -> nb::Result<(), Self::Error>;
+    fn send(&mut self, word: Word) -> nb::Result<(), Self::Error>;
 }
 
 /// Timer used for timeouts
@@ -837,16 +837,16 @@ pub trait Timer {
     fn get_timeout(&self) -> Self::Time;
 
     /// Pauses the timer
-    fn pause(&self);
+    fn pause(&mut self);
 
     /// Restarts the timer count to zero
-    fn restart(&self);
+    fn restart(&mut self);
 
     /// Resumes the timer count
-    fn resume(&self);
+    fn resume(&mut self);
 
     /// Sets a new timeout
-    fn set_timeout<T>(&self, timeout: T)
+    fn set_timeout<T>(&mut self, timeout: T)
     where
         T: Into<Self::Time>;
 

src/serial.rs

@@ -16,7 +16,7 @@ pub trait Read<Word> {
     type Error;
 
     /// Reads a single word from the serial interface
-    fn read(&self) -> nb::Result<Word, Self::Error>;
+    fn read(&mut self) -> nb::Result<Word, Self::Error>;
 }
 
 /// Write half of a serial interface
@@ -25,5 +25,5 @@ pub trait Write<Word> {
     type Error;
 
     /// Writes a single word to the serial interface
-    fn write(&self, word: Word) -> nb::Result<(), Self::Error>;
+    fn write(&mut self, word: Word) -> nb::Result<(), Self::Error>;
 }