Rename use_tokio feature async-tokio

Author: eldruin

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Changed
 
+- [breaking-change] Renamed `use_tokio` feature `async-tokio`.
 - Migrated to 'tokio' crate.
 - Updated `nix` to version 0.22.
 - Minimmum supported Rust version updated to 1.46.0.

Cargo.toml

@@ -11,7 +11,7 @@ readme = "README.md"
 
 [features]
 mio-evented = ["mio"]
-use_tokio = ["futures", "tokio", "mio-evented"]
+async-tokio = ["futures", "tokio", "mio-evented"]
 
 [dependencies]
 futures = { version = "0.1", optional = true }

README.md

@@ -82,7 +82,7 @@ The following features are planned for the library:
 - [x] Support for configuring interrupts on GPIO
 - [x] Support for polling on GPIO with configured interrupt
 - [x] Support for asynchronous polling using `mio` or `tokio` (requires
-      enabling the `mio-evented` or `use_tokio` crate features, respectively)
+      enabling the `mio-evented` or `async-tokio` crate features, respectively)
 
 ## Minimum Supported Rust Version (MSRV)
 

examples/tokio.rs

@@ -1,20 +1,20 @@
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 extern crate futures;
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 extern crate sysfs_gpio;
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 extern crate tokio;
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 use std::env;
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 use futures::{lazy, Future, Stream};
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 use sysfs_gpio::{Direction, Edge, Pin};
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 fn stream(pin_nums: Vec<u64>) -> sysfs_gpio::Result<()> {
     // NOTE: this currently runs forever and as such if
     // the app is stopped (Ctrl-C), no cleanup will happen
@@ -44,7 +44,7 @@ fn stream(pin_nums: Vec<u64>) -> sysfs_gpio::Result<()> {
     Ok(())
 }
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 fn main() {
     let pins: Vec<u64> = env::args()
         .skip(1)
@@ -57,7 +57,7 @@ fn main() {
     }
 }
 
-#[cfg(not(feature = "use_tokio"))]
+#[cfg(not(feature = "async-tokio"))]
 fn main() {
     println!("This example requires the `tokio` feature to be enabled.");
 }

src/lib.rs

@@ -42,26 +42,26 @@
 //! }
 //! ```
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 extern crate futures;
 #[cfg(feature = "mio-evented")]
 extern crate mio;
 #[cfg(not(target_os = "wasi"))]
 extern crate nix;
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 extern crate tokio;
 
 use std::fs;
 use std::fs::File;
 use std::io;
 use std::io::prelude::*;
-#[cfg(any(target_os = "linux", target_os = "android", feature = "use_tokio"))]
+#[cfg(any(target_os = "linux", target_os = "android", feature = "async-tokio"))]
 use std::io::SeekFrom;
 #[cfg(not(target_os = "wasi"))]
 use std::os::unix::prelude::*;
 use std::path::Path;
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 use futures::{Async, Poll, Stream};
 #[cfg(feature = "mio-evented")]
 use mio::unix::EventedFd;
@@ -71,7 +71,7 @@ use mio::Evented;
 use nix::sys::epoll::*;
 #[cfg(not(target_os = "wasi"))]
 use nix::unistd::close;
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 use tokio::reactor::{Handle, PollEvented};
 
 pub use error::Error;
@@ -126,7 +126,7 @@ fn flush_input_from_file(dev_file: &mut File, max: usize) -> io::Result<usize> {
 }
 
 /// Get the pin value from the provided file
-#[cfg(any(target_os = "linux", target_os = "android", feature = "use_tokio"))]
+#[cfg(any(target_os = "linux", target_os = "android", feature = "async-tokio"))]
 fn get_value_from_file(dev_file: &mut File) -> Result<u8> {
     let mut s = String::with_capacity(10);
     dev_file.seek(SeekFrom::Start(0))?;
@@ -475,8 +475,8 @@ impl Pin {
     /// The PinStream object can be used with the `tokio` crate. You should probably call
     /// `set_edge()` before using this.
     ///
-    /// This method is only available when the `use_tokio` crate feature is enabled.
-    #[cfg(feature = "use_tokio")]
+    /// This method is only available when the `async-tokio` crate feature is enabled.
+    #[cfg(feature = "async-tokio")]
     pub fn get_stream_with_handle(&self, handle: &Handle) -> Result<PinStream> {
         PinStream::init_with_handle(*self, handle)
     }
@@ -486,8 +486,8 @@ impl Pin {
     /// The PinStream object can be used with the `tokio` crate. You should probably call
     /// `set_edge()` before using this.
     ///
-    /// This method is only available when the `use_tokio` crate feature is enabled.
-    #[cfg(feature = "use_tokio")]
+    /// This method is only available when the `async-tokio` crate feature is enabled.
+    #[cfg(feature = "async-tokio")]
     pub fn get_stream(&self) -> Result<PinStream> {
         PinStream::init(*self)
     }
@@ -502,8 +502,8 @@ impl Pin {
     /// it could end up producing the same value multiple times if the value has changed back
     /// between when the interrupt occurred and when the value was read.
     ///
-    /// This method is only available when the `use_tokio` crate feature is enabled.
-    #[cfg(feature = "use_tokio")]
+    /// This method is only available when the `async-tokio` crate feature is enabled.
+    #[cfg(feature = "async-tokio")]
     pub fn get_value_stream_with_handle(&self, handle: &Handle) -> Result<PinValueStream> {
         Ok(PinValueStream(PinStream::init_with_handle(*self, handle)?))
     }
@@ -518,8 +518,8 @@ impl Pin {
     /// it could end up producing the same value multiple times if the value has changed back
     /// between when the interrupt occurred and when the value was read.
     ///
-    /// This method is only available when the `use_tokio` crate feature is enabled.
-    #[cfg(feature = "use_tokio")]
+    /// This method is only available when the `async-tokio` crate feature is enabled.
+    #[cfg(feature = "async-tokio")]
     pub fn get_value_stream(&self) -> Result<PinValueStream> {
         Ok(PinValueStream(PinStream::init(*self)?))
     }
@@ -667,13 +667,13 @@ impl Evented for AsyncPinPoller {
     }
 }
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 pub struct PinStream {
     evented: PollEvented<AsyncPinPoller>,
     skipped_first_event: bool,
 }
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 impl PinStream {
     pub fn init_with_handle(pin: Pin, handle: &Handle) -> Result<Self> {
         Ok(PinStream {
@@ -683,7 +683,7 @@ impl PinStream {
     }
 }
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 impl PinStream {
     pub fn init(pin: Pin) -> Result<Self> {
         Ok(PinStream {
@@ -693,7 +693,7 @@ impl PinStream {
     }
 }
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 impl Stream for PinStream {
     type Item = ();
     type Error = Error;
@@ -714,18 +714,18 @@ impl Stream for PinStream {
     }
 }
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 pub struct PinValueStream(PinStream);
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 impl PinValueStream {
     #[inline]
     fn get_value(&mut self) -> Result<u8> {
         get_value_from_file(&mut self.0.evented.get_mut().devfile)
     }
 }
 
-#[cfg(feature = "use_tokio")]
+#[cfg(feature = "async-tokio")]
 impl Stream for PinValueStream {
     type Item = u8;
     type Error = Error;