Turn modules inside-out

Author: eldruin

CHANGELOG.md

@@ -15,9 +15,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 - Swap PWM channel arguments to references
 - All trait methods have been renamed to remove the `try_` prefix (i.e. `try_send` -> `send`) for consistency.
-- Moved all traits into two modules depending on the execution model: `blocking` and `nb` (non-blocking).
+- Moved all traits into two sub modules for each feature depending on the execution model: `blocking` and `nb` (non-blocking). For example, the spi traits can now be found under `embedded_hal::spi::blocking` or `embedded_hal::spi::nb`.
 - Re-export `nb::{block!, Error, Result}` to avoid version mismatches. These should be used instead of
-  importing the `nb` crate directly in dependendent crates.
+  importing the `nb` crate directly in dependent 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.
 - Removed the various `Default` marker traits.

src/adc/mod.rs

@@ -0,0 +1,3 @@
+//! Analog-digital conversion traits
+
+pub mod nb;

src/nb/adc.rs renamed to src/adc/nb.rs

@@ -8,7 +8,7 @@
 ///
 /// ```
 /// # use core::marker::PhantomData;
-/// # use embedded_hal::nb::adc::Channel;
+/// # use embedded_hal::adc::nb::Channel;
 ///
 /// struct Adc1; // Example ADC with single bank of 8 channels
 /// struct Gpio1Pin1<MODE>(PhantomData<MODE>);
@@ -55,7 +55,7 @@ pub trait Channel<ADC> {
 /// of the request (in contrast to continuous asynchronous sampling).
 ///
 /// ```
-/// use embedded_hal::nb::adc::{Channel, OneShot};
+/// use embedded_hal::adc::nb::{Channel, OneShot};
 ///
 /// struct MyAdc; // 10-bit ADC, with 5 channels
 /// # impl MyAdc {

src/blocking/mod.rs

@@ -0,0 +1,3 @@
+//! Input capture traits
+
+pub mod nb;

src/capture/mod.rs

@@ -0,0 +1,3 @@
+//! Delay traits
+
+pub mod blocking;

src/nb/capture.rs renamed to src/capture/nb.rs

@@ -1,4 +1,8 @@
 //! Digital I/O
+//!
+//! In some cases it's possible to implement these blocking traits on top of one of the core HAL
+//! traits. To save boilerplate when that's the case a `Default` marker trait may be provided.
+//! Implementing that marker trait will opt in your type into a blanket implementation.
 
 use core::{convert::From, ops::Not};
 
@@ -7,7 +11,7 @@ use core::{convert::From, ops::Not};
 /// Conversion from `bool` and logical negation are also implemented
 /// for this type.
 /// ```rust
-/// # use embedded_hal::blocking::digital::PinState;
+/// # use embedded_hal::digital::blocking::PinState;
 /// let state = PinState::from(false);
 /// assert_eq!(state, PinState::Low);
 /// assert_eq!(!state, PinState::High);
@@ -115,7 +119,7 @@ pub trait InputPin {
 ///
 /// ```
 /// use core::time::Duration;
-/// use embedded_hal::blocking::digital::{IoPin, InputPin, OutputPin};
+/// use embedded_hal::digital::blocking::{IoPin, InputPin, OutputPin};
 ///
 /// pub fn ping_and_read<TInputPin, TOutputPin, TError>(
 ///     mut pin: TOutputPin, delay_fn: &dyn Fn(Duration) -> ()) -> Result<bool, TError>

src/blocking/delay.rs renamed to src/delay/blocking.rs

@@ -0,0 +1,3 @@
+//! Digital I/O traits
+
+pub mod blocking;