Merge branch 'master' into master

Author: lachlansneff

CHANGELOG.md

@@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Moved all traits into two modules depending on the execution model: `blocking` and `nb` (non-blocking).
 - Re-export `nb::{block!, Error, Result}` to avoid version mismatches. These should be used instead of
   importing the `nb` crate directly in dependendent crates.
+- `blocking::Serial`: renamed `bwrite_all` to `write`, `bflush` to `flush.
+- Removed `prelude` to avoid method name conflicts between different flavors (blocking, nb) of the same trait. Traits must now be manually imported.
 
 ## [v1.0.0-alpha.4] - 2020-11-11
 

src/blocking/pwm.rs

@@ -9,7 +9,7 @@
 /// ```
 /// extern crate embedded_hal as hal;
 ///
-/// use hal::prelude::*;
+/// use hal::blocking::pwm::Pwm;
 ///
 /// fn main() {
 ///     let mut pwm: Pwm1 = {

src/blocking/qei.rs

@@ -11,7 +11,8 @@
 /// #[macro_use(block)]
 /// extern crate nb;
 ///
-/// use hal::prelude::*;
+/// use hal::blocking::qei::Qei;
+/// use hal::nb::timer::CountDown;
 ///
 /// fn main() {
 ///     let mut qei: Qei1 = {

src/blocking/serial.rs

@@ -10,13 +10,13 @@ pub trait Write<Word> {
     /// An implementation can choose to buffer the write, returning `Ok(())`
     /// after the complete slice has been written to a buffer, but before all
     /// words have been sent via the serial interface. To make sure that
-    /// everything has been sent, call [`bflush`] after this function returns.
+    /// everything has been sent, call [`flush`] after this function returns.
     ///
-    /// [`bflush`]: #tymethod.bflush
-    fn bwrite_all(&mut self, buffer: &[Word]) -> Result<(), Self::Error>;
+    /// [`flush`]: #tymethod.flush
+    fn write(&mut self, buffer: &[Word]) -> Result<(), Self::Error>;
 
     /// Block until the serial interface has sent all buffered words
-    fn bflush(&mut self) -> Result<(), Self::Error>;
+    fn flush(&mut self) -> Result<(), Self::Error>;
 }
 
 /// Blocking serial write
@@ -38,15 +38,15 @@ pub mod write {
     {
         type Error = S::Error;
 
-        fn bwrite_all(&mut self, buffer: &[Word]) -> Result<(), Self::Error> {
+        fn write(&mut self, buffer: &[Word]) -> Result<(), Self::Error> {
             for word in buffer {
                 nb::block!(self.write(word.clone()))?;
             }
 
             Ok(())
         }
 
-        fn bflush(&mut self) -> Result<(), Self::Error> {
+        fn flush(&mut self) -> Result<(), Self::Error> {
             nb::block!(self.flush())?;
             Ok(())
         }

src/lib.rs

@@ -244,7 +244,7 @@
 //! ```
 //! use embedded_hal as hal;
 //! use nb::block;
-//! use hal::prelude::*;
+//! use hal::nb::serial::Write;
 //!
 //! fn write_all<S>(serial: &mut S, buffer: &[u8]) -> Result<(), S::Error>
 //! where
@@ -266,7 +266,8 @@
 //! use embedded_hal as hal;
 //! use nb;
 //!
-//! use hal::prelude::*;
+//! use hal::nb::serial::Write;
+//! use hal::nb::timer::CountDown;
 //!
 //! enum Error<SE, TE> {
 //!     /// Serial interface error
@@ -320,7 +321,7 @@
 //! use embedded_hal as hal;
 //! use nb;
 //!
-//! use hal::prelude::*;
+//! use hal::nb::serial::Write;
 //! use ::core::convert::Infallible;
 //!
 //! fn flush<S>(serial: &mut S, cb: &mut CircularBuffer)
@@ -414,7 +415,6 @@ pub mod fmt;
 pub mod nb;
 #[cfg(feature = "unstable-futures")]
 pub mod futures;
-pub mod prelude;
 
 mod private {
     use crate::blocking::i2c::{SevenBitAddress, TenBitAddress};

src/nb/capture.rs

@@ -12,7 +12,7 @@
 /// #[macro_use(block)]
 /// extern crate nb;
 ///
-/// use hal::prelude::*;
+/// use hal::nb::capture::Capture;
 ///
 /// fn main() {
 ///     let mut capture: Capture1 = {

src/nb/timer.rs

@@ -19,7 +19,7 @@
 /// #[macro_use(block)]
 /// extern crate nb;
 ///
-/// use hal::prelude::*;
+/// use hal::nb::timer::CountDown;
 ///
 /// fn main() {
 ///     let mut led: Led = {