Merge #282

282: Remove prelude. r=therealprof a=Dirbaio

**DEPENDS on #280**

Following discussions in #280 #281, we might want to use the same method names for the `blocking` and `nb` (and in the future, `futures`) trait flavors.

In that case, importing the prelude guarantees naming conflicts, so it's better to remove it.

An alternative would be splitting the prelude in `blocking` and `nb`. However, users often use blocking trait A and nonblocking trait B at the same time, so they'd end up importing both preludes and having name conflicts anyway.

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

Author: bors[bot]

CHANGELOG.md

@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - 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/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)
@@ -411,7 +412,6 @@
 pub mod blocking;
 pub mod fmt;
 pub mod nb;
-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 = {