Remove unproven feature

Author: eldruin

Cargo.toml

@@ -14,15 +14,10 @@ readme = "README.md"
 repository = "https://github.com/rust-embedded/embedded-hal"
 version = "0.2.3"
 
-[dependencies.nb]
-version = "0.1.1"
+[dependencies]
+nb = { version = "0.1.1", features = ["unstable"] }
 
 [dev-dependencies]
 stm32f3 = { version = "0.8", features = ["stm32f303", "rt"] }
 futures = "0.1.17"
 
-[features]
-unproven = ["nb/unstable"]
-
-[package.metadata.docs.rs]
-features = ["unproven"]

ci/script.sh

@@ -2,11 +2,10 @@ set -euxo pipefail
 
 main() {
     cargo check --target $TARGET
-    cargo check --target $TARGET --features unproven
     cargo fmt -- --check
 
     if [ $TRAVIS_RUST_VERSION = nightly ]; then
-        cargo test --target $TARGET --features unproven
+        cargo test --target $TARGET
     fi
 }
 

src/adc.rs

@@ -1,6 +1,5 @@
 //! Analog-digital conversion traits
 
-#[cfg(feature = "unproven")]
 use nb;
 
 /// A marker trait to identify MCU pins that can be used as inputs to an ADC channel.
@@ -35,7 +34,6 @@ use nb;
 ///     fn channel() -> (u8, u8) { (0, 3) } // bank 0 channel 3
 /// }
 /// ```
-#[cfg(feature = "unproven")]
 pub trait Channel<ADC> {
     /// Channel ID type
     ///
@@ -85,7 +83,6 @@ pub trait Channel<ADC> {
 ///    }
 /// }
 /// ```
-#[cfg(feature = "unproven")]
 pub trait OneShot<ADC, Word, Pin: Channel<ADC>> {
     /// Error type returned by ADC methods
     type Error;

src/blocking/i2c.rs

@@ -56,7 +56,6 @@ pub trait Write {
 }
 
 /// Blocking write (iterator version)
-#[cfg(feature = "unproven")]
 pub trait WriteIter {
     /// Error type
     type Error;
@@ -107,7 +106,6 @@ pub trait WriteRead {
 }
 
 /// Blocking write (iterator version) + read
-#[cfg(feature = "unproven")]
 pub trait WriteIterRead {
     /// Error type
     type Error;

src/blocking/rng.rs

@@ -1,9 +1,6 @@
 //! Blocking hardware random number generator
 
 /// Blocking read
-///
-/// *This trait is available if embedded-hal is built with the `"unproven"` feature.*
-#[cfg(feature = "unproven")]
 pub trait Read {
     /// Error type
     type Error;

src/blocking/spi.rs

@@ -19,7 +19,6 @@ pub trait Write<W> {
 }
 
 /// Blocking write (iterator version)
-#[cfg(feature = "unproven")]
 pub trait WriteIter<W> {
     /// Error type
     type Error;
@@ -78,7 +77,6 @@ pub mod write {
 }
 
 /// Blocking write (iterator version)
-#[cfg(feature = "unproven")]
 pub mod write_iter {
     /// Default implementation of `blocking::spi::WriteIter<W>` for implementers of
     /// `spi::FullDuplex<W>`

src/digital.rs

@@ -19,9 +19,6 @@ pub trait OutputPin {
 }
 
 /// Push-pull output pin that can read its output state
-///
-/// *This trait is available if embedded-hal is built with the `"unproven"` feature.*
-#[cfg(feature = "unproven")]
 pub trait StatefulOutputPin: OutputPin {
     /// Is the pin in drive high mode?
     ///
@@ -36,13 +33,10 @@ pub trait StatefulOutputPin: OutputPin {
 
 /// Output pin that can be toggled
 ///
-/// *This trait is available if embedded-hal is built with the `"unproven"` feature.*
-///
 /// See [toggleable](toggleable) to use a software implementation if
 /// both [OutputPin](trait.OutputPin.html) and
 /// [StatefulOutputPin](trait.StatefulOutputPin.html) are
 /// implemented. Otherwise, implement this using hardware mechanisms.
-#[cfg(feature = "unproven")]
 pub trait ToggleableOutputPin {
     /// Error type
     type Error;
@@ -95,13 +89,10 @@ pub trait ToggleableOutputPin {
 /// pin.try_toggle().unwrap();
 /// assert!(pin.try_is_set_low().unwrap());
 /// ```
-#[cfg(feature = "unproven")]
 pub mod toggleable {
     use super::{OutputPin, StatefulOutputPin, ToggleableOutputPin};
 
     /// Software-driven `toggle()` implementation.
-    ///
-    /// *This trait is available if embedded-hal is built with the `"unproven"` feature.*
     pub trait Default: OutputPin + StatefulOutputPin {}
 
     impl<P> ToggleableOutputPin for P

src/lib.rs

@@ -2,10 +2,7 @@
 //!
 //! **NOTE** This HAL is still is active development. Expect the traits presented here to be
 //! tweaked, split or be replaced wholesale before being stabilized, i.e. before hitting the 1.0.0
-//! release. That being said there's a part of the HAL that's currently considered unproven and is
-//! hidden behind an "unproven" Cargo feature. This API is even more volatile and it's exempt from
-//! semver rules: it can change in a non-backward compatible fashion or even disappear in between
-//! patch releases.
+//! release.
 //!
 //! # Design goals
 //!
@@ -702,8 +699,6 @@ pub mod watchdog;
 
 /// Input capture
 ///
-/// *This trait is available if embedded-hal is built with the `"unproven"` feature.*
-///
 /// # Examples
 ///
 /// You can use this interface to measure the period of (quasi) periodic signals
@@ -742,17 +737,15 @@ pub mod watchdog;
 /// #     type Error = Infallible;
 /// #     type Capture = u16;
 /// #     type Channel = Channel;
-/// #     type Error = Infallible;
 /// #     type Time = MilliSeconds;
 /// #     fn try_capture(&mut self, _: Channel) -> ::nb::Result<u16, Self::Error> { Ok(0) }
 /// #     fn try_disable(&mut self, _: Channel) -> Result<(), Self::Error> { unimplemented!() }
 /// #     fn try_enable(&mut self, _: Channel) -> Result<(), Self::Error> { unimplemented!() }
 /// #     fn try_get_resolution(&self) -> Result<MilliSeconds, Self::Error> { unimplemented!() }
-/// #     fn try_set_resolution<T>(&mut self, _: T) -> Result<(), Self::Error> where T: Into<MilliSeconds> {}
+/// #     fn try_set_resolution<T>(&mut self, _: T) -> Result<(), Self::Error> where T: Into<MilliSeconds> { Ok(()) }
 /// # }
 /// ```
-#[cfg(feature = "unproven")]
-// reason: pre-singletons API. With singletons a `CapturePin` (cf. `PwmPin`) trait seems more
+// unproven reason: pre-singletons API. With singletons a `CapturePin` (cf. `PwmPin`) trait seems more
 // appropriate
 pub trait Capture {
     /// Enumeration of `Capture` errors
@@ -799,8 +792,6 @@ pub trait Capture {
 
 /// Pulse Width Modulation
 ///
-/// *This trait is available if embedded-hal is built with the `"unproven"` feature.*
-///
 /// # Examples
 ///
 /// Use this interface to control the power output of some actuator
@@ -841,14 +832,13 @@ pub trait Capture {
 /// #     fn try_disable(&mut self, _: Channel) -> Result<(), Self::Error> { unimplemented!() }
 /// #     fn try_enable(&mut self, _: Channel) -> Result<(), Self::Error> { unimplemented!() }
 /// #     fn try_get_duty(&self, _: Channel) -> Result<u16, Self::Error> { unimplemented!() }
-/// #     fn try_get_max_duty(&self) -> Result<u16, Self::Error> { 0 }
-/// #     fn try_set_duty(&mut self, _: Channel, _: u16) -> Result<(), Self::Error> {}
+/// #     fn try_get_max_duty(&self) -> Result<u16, Self::Error> { Ok(0) }
+/// #     fn try_set_duty(&mut self, _: Channel, _: u16) -> Result<(), Self::Error> { Ok(()) }
 /// #     fn try_get_period(&self) -> Result<KiloHertz, Self::Error> { unimplemented!() }
-/// #     fn try_set_period<T>(&mut self, _: T) -> Result<(), Self::Error> where T: Into<KiloHertz> {}
+/// #     fn try_set_period<T>(&mut self, _: T) -> Result<(), Self::Error> where T: Into<KiloHertz> { Ok(()) }
 /// # }
 /// ```
-#[cfg(feature = "unproven")]
-// reason: pre-singletons API. The `PwmPin` trait seems more useful because it models independent
+// unproven reason: pre-singletons API. The `PwmPin` trait seems more useful because it models independent
 // PWM channels. Here a certain number of channels are multiplexed in a single implementer.
 pub trait Pwm {
     /// Enumeration of `Pwm` errors
@@ -925,8 +915,6 @@ pub trait PwmPin {
 
 /// Quadrature encoder interface
 ///
-/// *This trait is available if embedded-hal is built with the `"unproven"` feature.*
-///
 /// # Examples
 ///
 /// You can use this interface to measure the speed of a motor
@@ -971,13 +959,13 @@ pub trait PwmPin {
 /// # }
 /// # struct Timer6;
 /// # impl hal::timer::CountDown for Timer6 {
+/// #     type Error = Infallible;
 /// #     type Time = Seconds;
 /// #     fn try_start<T>(&mut self, _: T) -> Result<(), Infallible> where T: Into<Seconds> { Ok(()) }
 /// #     fn try_wait(&mut self) -> ::nb::Result<(), Infallible> { Ok(()) }
 /// # }
 /// ```
-#[cfg(feature = "unproven")]
-// reason: needs to be re-evaluated in the new singletons world. At the very least this needs a
+// unproven reason: needs to be re-evaluated in the new singletons world. At the very least this needs a
 // reference implementation
 pub trait Qei {
     /// Enumeration of `Qei` errors
@@ -994,11 +982,7 @@ pub trait Qei {
 }
 
 /// Count direction
-///
-/// *This enumeration is available if embedded-hal is built with the `"unproven"` feature.*
 #[derive(Clone, Copy, Debug, Eq, PartialEq)]
-#[cfg(feature = "unproven")]
-// reason: part of the unproven `Qei` interface
 pub enum Direction {
     /// 3, 2, 1
     Downcounting,

src/prelude.rs

@@ -3,44 +3,30 @@
 //! The traits have been renamed to avoid collisions with other items when
 //! performing a glob import.
 
-#[cfg(feature = "unproven")]
 pub use crate::adc::OneShot as _embedded_hal_adc_OneShot;
 pub use crate::blocking::delay::DelayMs as _embedded_hal_blocking_delay_DelayMs;
 pub use crate::blocking::delay::DelayUs as _embedded_hal_blocking_delay_DelayUs;
 pub use crate::blocking::i2c::{
     Read as _embedded_hal_blocking_i2c_Read, Write as _embedded_hal_blocking_i2c_Write,
     WriteRead as _embedded_hal_blocking_i2c_WriteRead,
 };
-#[cfg(feature = "unproven")]
 pub use crate::blocking::rng::Read as _embedded_hal_blocking_rng_Read;
 pub use crate::blocking::serial::Write as _embedded_hal_blocking_serial_Write;
 pub use crate::blocking::spi::{
     Transfer as _embedded_hal_blocking_spi_Transfer, Write as _embedded_hal_blocking_spi_Write,
 };
-#[allow(deprecated)]
-#[cfg(feature = "unproven")]
 pub use crate::digital::InputPin as _embedded_hal_digital_InputPin;
-#[allow(deprecated)]
 pub use crate::digital::OutputPin as _embedded_hal_digital_OutputPin;
-#[cfg(feature = "unproven")]
-#[allow(deprecated)]
 pub use crate::digital::ToggleableOutputPin as _embedded_hal_digital_ToggleableOutputPin;
-#[cfg(feature = "unproven")]
 pub use crate::rng::Read as _embedded_hal_rng_Read;
 pub use crate::serial::Read as _embedded_hal_serial_Read;
 pub use crate::serial::Write as _embedded_hal_serial_Write;
 pub use crate::spi::FullDuplex as _embedded_hal_spi_FullDuplex;
 pub use crate::timer::CountDown as _embedded_hal_timer_CountDown;
-#[cfg(feature = "unproven")]
 pub use crate::watchdog::Watchdog as _embedded_hal_watchdog_Watchdog;
-#[cfg(feature = "unproven")]
 pub use crate::watchdog::WatchdogDisable as _embedded_hal_watchdog_WatchdogDisable;
-#[cfg(feature = "unproven")]
 pub use crate::watchdog::WatchdogEnable as _embedded_hal_watchdog_WatchdogEnable;
-#[cfg(feature = "unproven")]
 pub use crate::Capture as _embedded_hal_Capture;
-#[cfg(feature = "unproven")]
 pub use crate::Pwm as _embedded_hal_Pwm;
 pub use crate::PwmPin as _embedded_hal_PwmPin;
-#[cfg(feature = "unproven")]
 pub use crate::Qei as _embedded_hal_Qei;

src/rng.rs

@@ -1,11 +1,8 @@
 //! Random Number Generator Interface
 
-#[cfg(feature = "unproven")]
 use nb;
 
 /// Nonblocking stream of random bytes.
-#[cfg(feature = "unproven")]
-// reason: No implementation or users yet
 pub trait Read {
     /// An enumeration of RNG errors.
     ///

src/watchdog.rs

@@ -2,7 +2,6 @@
 
 /// Feeds an existing watchdog to ensure the processor isn't reset. Sometimes
 /// commonly referred to as "kicking" or "refreshing".
-#[cfg(feature = "unproven")]
 pub trait Watchdog {
     /// An enumeration of `Watchdog` errors.
     ///
@@ -16,7 +15,6 @@ pub trait Watchdog {
 
 /// Enables A watchdog timer to reset the processor if software is frozen or
 /// stalled.
-#[cfg(feature = "unproven")]
 pub trait WatchdogEnable {
     /// An enumeration of `WatchdogEnable` errors.
     ///
@@ -34,7 +32,6 @@ pub trait WatchdogEnable {
 }
 
 /// Disables a running watchdog timer so the processor won't be reset.
-#[cfg(feature = "unproven")]
 pub trait WatchdogDisable {
     /// An enumeration of `WatchdogDisable` errors.
     ///