rename to async-ready

Signed-off-by: Yoshua Wuyts <[email protected]>

Author: yoshuawuyts

CHANGELOG.md

@@ -1,8 +1,8 @@
 ## 2019-03-07, Version 1.1.0
 ### Commits
-- [[`36ee5ddeb8`](https://github.com/yoshuawuyts/ready/commit/36ee5ddeb8e72af386ee9a17351eeae309e3c98e)] (cargo-release) version 1.1.0 (Yoshua Wuyts)
-- [[`21746f6bb6`](https://github.com/yoshuawuyts/ready/commit/21746f6bb6019583b362b98b8090ca05c4ffe136)] add TakeError (Yoshua Wuyts)
-- [[`6014621dbe`](https://github.com/yoshuawuyts/ready/commit/6014621dbeb33f7f53ea0517cc59d40a3f030dde)] Update changelog (Yoshua Wuyts)
+- [[`36ee5ddeb8`](https://github.com/yoshuawuyts/async-ready/commit/36ee5ddeb8e72af386ee9a17351eeae309e3c98e)] (cargo-release) version 1.1.0 (Yoshua Wuyts)
+- [[`21746f6bb6`](https://github.com/yoshuawuyts/async-ready/commit/21746f6bb6019583b362b98b8090ca05c4ffe136)] add TakeError (Yoshua Wuyts)
+- [[`6014621dbe`](https://github.com/yoshuawuyts/async-ready/commit/6014621dbeb33f7f53ea0517cc59d40a3f030dde)] Update changelog (Yoshua Wuyts)
 
 ### Stats
 ```diff
@@ -15,9 +15,9 @@
 
 ## 2019-03-07, Version 1.0.2
 ### Commits
-- [[`98cecf5a32`](https://github.com/yoshuawuyts/ready/commit/98cecf5a32491a3d9fb238954ba6adbb619f1cf6)] (cargo-release) version 1.0.2 (Yoshua Wuyts)
-- [[`ab5beaa174`](https://github.com/yoshuawuyts/ready/commit/ab5beaa174a79cdea95bfbbc640909c0dcf740f8)] fix mutability (Yoshua Wuyts)
-- [[`38271c0725`](https://github.com/yoshuawuyts/ready/commit/38271c0725a0cd27d2faffd5ea943c74e74bb718)] Update changelog (Yoshua Wuyts)
+- [[`98cecf5a32`](https://github.com/yoshuawuyts/async-ready/commit/98cecf5a32491a3d9fb238954ba6adbb619f1cf6)] (cargo-release) version 1.0.2 (Yoshua Wuyts)
+- [[`ab5beaa174`](https://github.com/yoshuawuyts/async-ready/commit/ab5beaa174a79cdea95bfbbc640909c0dcf740f8)] fix mutability (Yoshua Wuyts)
+- [[`38271c0725`](https://github.com/yoshuawuyts/async-ready/commit/38271c0725a0cd27d2faffd5ea943c74e74bb718)] Update changelog (Yoshua Wuyts)
 
 ### Stats
 ```diff
@@ -30,9 +30,9 @@
 
 ## 2019-03-07, Version 1.0.1
 ### Commits
-- [[`455bd12a1a`](https://github.com/yoshuawuyts/ready/commit/455bd12a1aeac3deae4c8432050b69eced51b956)] (cargo-release) version 1.0.1 (Yoshua Wuyts)
-- [[`331b94abd0`](https://github.com/yoshuawuyts/ready/commit/331b94abd01c5848e51584ebf3ce5684cf08dd02)] tweak desc (Yoshua Wuyts)
-- [[`9ea6f9f059`](https://github.com/yoshuawuyts/ready/commit/9ea6f9f0594e56261e46261b08ccfdebf7012299)] . (Yoshua Wuyts)
+- [[`455bd12a1a`](https://github.com/yoshuawuyts/async-ready/commit/455bd12a1aeac3deae4c8432050b69eced51b956)] (cargo-release) version 1.0.1 (Yoshua Wuyts)
+- [[`331b94abd0`](https://github.com/yoshuawuyts/async-ready/commit/331b94abd01c5848e51584ebf3ce5684cf08dd02)] tweak desc (Yoshua Wuyts)
+- [[`9ea6f9f059`](https://github.com/yoshuawuyts/async-ready/commit/9ea6f9f0594e56261e46261b08ccfdebf7012299)] . (Yoshua Wuyts)
 
 ### Stats
 ```diff

Cargo.toml

@@ -1,11 +1,11 @@
 [package]
-name = "ready"
-version = "1.1.0"
+name = "async-ready"
+version = "1.0.0"
 license = "MIT OR Apache-2.0"
-repository = "https://github.com/yoshuawuyts/ready"
-documentation = "https://docs.rs/ready"
-description = "Async ready states."
-keywords = ["async", "ready", "poll_ready"]
+repository = "https://github.com/yoshuawuyts/async-ready"
+documentation = "https://docs.rs/async-ready"
+description = "Async async-ready states."
+keywords = ["async", "ready_state", "poll_ready"]
 categories = ["asynchronous"]
 authors = ["Yoshua Wuyts <[email protected]>"]
 readme = "README.md"

README.md

@@ -1,4 +1,4 @@
-# ready
+# async-ready
 [![crates.io version][1]][2] [![build status][3]][4]
 [![downloads][5]][6] [![docs.rs docs][7]][8]
 
@@ -17,6 +17,7 @@ __Basic usage__
 use std::pin::Pin;
 use std::task::{Poll, Waker};
 use futures::prelude::*;
+use async_ready::AsyncReady;
 use std::io;
 
 struct Fut;
@@ -28,10 +29,11 @@ impl Future for Fut {
   }
 }
 
-impl ready::Ready for Fut {
+impl AsyncReady for Fut {
   type Ok = ();
   type Err = io::Error;
-  fn poll_ready(&self, waker: &Waker)
+
+  fn poll_ready(&mut self, waker: &Waker)
     -> Poll<Result<Self::Ok, Self::Err>> {
     Poll::Ready(Ok(()))
   }
@@ -40,7 +42,7 @@ impl ready::Ready for Fut {
 
 ## Installation
 ```sh
-$ cargo add ready
+$ cargo add async-ready
 ```
 
 ## Safety
@@ -60,16 +62,16 @@ None.
 ## License
 [MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE)
 
-[1]: https://img.shields.io/crates/v/ready.svg?style=flat-square
-[2]: https://crates.io/crates/ready
-[3]: https://img.shields.io/travis/yoshuawuyts/ready/master.svg?style=flat-square
-[4]: https://travis-ci.org/yoshuawuyts/ready
-[5]: https://img.shields.io/crates/d/ready.svg?style=flat-square
-[6]: https://crates.io/crates/ready
+[1]: https://img.shields.io/crates/v/async-ready.svg?style=flat-square
+[2]: https://crates.io/crates/async-ready
+[3]: https://img.shields.io/travis/yoshuawuyts/async-ready/master.svg?style=flat-square
+[4]: https://travis-ci.org/yoshuawuyts/async-ready
+[5]: https://img.shields.io/crates/d/async-ready.svg?style=flat-square
+[6]: https://crates.io/crates/async-ready
 [7]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square
-[8]: https://docs.rs/ready
+[8]: https://docs.rs/async-ready
 
-[releases]: https://github.com/yoshuawuyts/ready/releases
-[contributing]: https://github.com/yoshuawuyts/ready/blob/master.github/CONTRIBUTING.md
-[good-first-issue]: https://github.com/yoshuawuyts/ready/labels/good%20first%20issue
-[help-wanted]: https://github.com/yoshuawuyts/ready/labels/help%20wanted
+[releases]: https://github.com/yoshuawuyts/async-ready/releases
+[contributing]: https://github.com/yoshuawuyts/async-ready/blob/master.github/CONTRIBUTING.md
+[good-first-issue]: https://github.com/yoshuawuyts/async-ready/labels/good%20first%20issue
+[help-wanted]: https://github.com/yoshuawuyts/async-ready/labels/help%20wanted

src/lib.rs

@@ -3,6 +3,9 @@
 #![deny(missing_docs)]
 #![cfg_attr(test, deny(warnings))]
 
+//! Async readiness traits. Useful when implementing async state machines
+//! that can later be wrapped in dedicated futures.
+//!
 //! ## Example
 //!
 //! ```rust
@@ -11,6 +14,7 @@
 //! use std::pin::Pin;
 //! use std::task::{Poll, Waker};
 //! use futures::prelude::*;
+//! use async_ready::AsyncReady;
 //! use std::io;
 //!
 //! struct Fut;
@@ -22,9 +26,10 @@
 //!   }
 //! }
 //!
-//! impl ready::Ready for Fut {
+//! impl AsyncReady for Fut {
 //!   type Ok = ();
 //!   type Err = io::Error;
+//!
 //!   fn poll_ready(&mut self, waker: &Waker)
 //!     -> Poll<Result<Self::Ok, Self::Err>> {
 //!     Poll::Ready(Ok(()))
@@ -37,7 +42,7 @@
 use std::task::{Poll, Waker};
 
 /// Determine if the underlying API can be written to.
-pub trait WriteReady {
+pub trait AsyncWriteReady {
   /// The type of successful values yielded by this trait.
   type Ok;
 
@@ -49,7 +54,7 @@ pub trait WriteReady {
 }
 
 /// Determine if the underlying API can be read from.
-pub trait ReadReady {
+pub trait AsyncReadReady {
   /// The type of successful values yielded by this trait.
   type Ok;
 
@@ -60,15 +65,15 @@ pub trait ReadReady {
   fn poll_read_ready(&mut self, waker: &Waker) -> Poll<Result<Self::Ok, Self::Err>>;
 }
 
-/// Determine if a struct is ready to yield futures.
+/// Determine if a struct is async-ready to yield futures.
 ///
 /// This is useful when a `Stream` borrows an internal struct, and the internal
 /// struct is in charge of establishing the io channel. That way the stream and
 /// the readiness can be decoupled.
 ///
-/// Once the IO channel is ready, `poll_ready` should always return
+/// Once the IO channel is async-ready, `poll_async-ready` should always return
 /// `Poll::Ready`.
-pub trait Ready {
+pub trait AsyncReady {
   /// The type of successful values yielded by this trait.
   type Ok;