├── tests └── test.rs ├── rustfmt.toml ├── .gitignore ├── .github ├── ISSUE_TEMPLATE.md ├── ISSUE_TEMPLATE │ ├── question.md │ ├── bug_report.md │ └── feature_request.md ├── stale.yml ├── PULL_REQUEST_TEMPLATE.md ├── CONTRIBUTING.md └── CODE_OF_CONDUCT.md ├── .travis.yml ├── Cargo.toml ├── LICENSE-MIT ├── CERTIFICATE ├── src ├── error.rs └── lib.rs ├── README.md ├── CHANGELOG.md └── LICENSE-APACHE /tests/test.rs: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /rustfmt.toml: -------------------------------------------------------------------------------- 1 | max_width = 80 2 | tab_spaces = 2 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | coverage/ 2 | target/ 3 | tmp/ 4 | dist/ 5 | npm-debug.log* 6 | Cargo.lock 7 | .DS_Store 8 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Summary 2 | Explain what is going on. 3 | 4 | ## Your Environment 5 | | Software | Version(s) | 6 | | ---------------- | ---------- | 7 | | ready | 8 | | Rustc | 9 | | Operating System | 10 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | rust: 3 | - nightly-2019-05-09 4 | 5 | before_script: | 6 | rustup component add rustfmt-preview && 7 | rustup component add clippy-preview 8 | script: | 9 | cargo fmt -- --check && 10 | cargo clippy -- -D clippy && 11 | cargo build --verbose && 12 | cargo test --verbose 13 | cache: cargo 14 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Question 3 | about: Have any questions regarding how ready works? 4 | --- 5 | 6 | # Question 7 | ## Your Environment 8 | | Software | Version(s) | 9 | | ---------------- | ---------- | 10 | | ready | 11 | | Rustc | 12 | | Operating System | 13 | 14 | ## Question 15 | Provide your question here. 16 | 17 | ## Context 18 | How has this issue affected you? What are you trying to accomplish? 19 | -------------------------------------------------------------------------------- /.github/stale.yml: -------------------------------------------------------------------------------- 1 | # Configuration for probot-stale - https://github.com/probot/stale 2 | 3 | daysUntilStale: 90 4 | daysUntilClose: 7 5 | exemptLabels: 6 | - pinned 7 | - security 8 | exemptProjects: false 9 | exemptMilestones: false 10 | staleLabel: wontfix 11 | markComment: > 12 | This issue has been automatically marked as stale because it has not had 13 | recent activity. It will be closed if no further activity occurs. Thank you 14 | for your contributions. 15 | unmarkComment: false 16 | closeComment: false 17 | limitPerRun: 30 18 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "async-ready" 3 | version = "3.0.0" 4 | license = "MIT OR Apache-2.0" 5 | repository = "https://github.com/rustasync/async-ready" 6 | documentation = "https://docs.rs/async-ready" 7 | description = "Async readiness traits." 8 | keywords = ["async", "ready_state", "poll_ready"] 9 | categories = ["asynchronous"] 10 | authors = ["The Rust Async Ecosystem Working Group"] 11 | readme = "README.md" 12 | edition = "2018" 13 | 14 | [dependencies] 15 | 16 | [dev-dependencies] 17 | futures-preview = "0.3.0-alpha.14" 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report 3 | about: Did something not work as expected? 4 | --- 5 | 6 | # Bug Report 7 | ## Your Environment 8 | | Software | Version(s) | 9 | | ---------------- | ---------- | 10 | | ready | 11 | | Rustc | 12 | | Operating System | 13 | 14 | ## Expected Behavior 15 | Tell us what should have happened. 16 | 17 | ## Current Behavior 18 | Tell us what happens instead of the expected behavior. If you are seeing an 19 | error, please include the full error message and stack trace. 20 | 21 | ## Code Sample 22 | Please provide a code repository, gist, code snippet or sample files to 23 | reproduce the issue. 24 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | **Choose one:** is this a 🐛 bug fix, a 🙋 feature, or a 🔦 documentation change? 8 | 9 | 10 | 11 | ## Checklist 12 | 13 | - [ ] tests pass 14 | - [ ] tests and/or benchmarks are included 15 | - [ ] documentation is changed or added 16 | 17 | ## Context 18 | 19 | 20 | ## Semver Changes 21 | 22 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2019 Yoshua Wuyts 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Want us to add something to ready? 4 | --- 5 | 6 | # Feature Request 7 | ## Summary 8 | One paragraph explanation of the feature. 9 | 10 | ## Motivation 11 | Why are we doing this? What use cases does it support? What is the expected 12 | outcome? 13 | 14 | ## Guide-level explanation 15 | Explain the proposal as if it was already included in the project and you 16 | were teaching it to another programmer. That generally means: 17 | 18 | - Introducing new named concepts. 19 | - Explaining the feature largely in terms of examples. 20 | - If applicable, provide sample error messages, deprecation warnings, or 21 | migration guidance. 22 | 23 | ## Reference-level explanation 24 | This is the technical portion of the feature request. Explain the design in 25 | sufficient detail that: 26 | 27 | - Its interaction with other features is clear. 28 | - It is reasonably clear how the feature would be implemented. 29 | - Corner cases are dissected by example. 30 | 31 | ## Drawbacks 32 | Why should we _not_ do this? 33 | 34 | ## Rationale and alternatives 35 | - Why is this design the best in the space of possible designs? 36 | - What other designs have been considered and what is the rationale for not 37 | choosing them? 38 | - What is the impact of not doing this? 39 | 40 | ## Unresolved Questions 41 | What related issues do you consider out of scope for this feature that could be 42 | addressed in the future independently of the solution that comes out of this 43 | feature? 44 | -------------------------------------------------------------------------------- /CERTIFICATE: -------------------------------------------------------------------------------- 1 | Developer Certificate of Origin 2 | Version 1.1 3 | 4 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 5 | 1 Letterman Drive 6 | Suite D4700 7 | San Francisco, CA, 94129 8 | 9 | Everyone is permitted to copy and distribute verbatim copies of this 10 | license document, but changing it is not allowed. 11 | 12 | 13 | Developer's Certificate of Origin 1.1 14 | 15 | By making a contribution to this project, I certify that: 16 | 17 | (a) The contribution was created in whole or in part by me and I 18 | have the right to submit it under the open source license 19 | indicated in the file; or 20 | 21 | (b) The contribution is based upon previous work that, to the best 22 | of my knowledge, is covered under an appropriate open source 23 | license and I have the right under that license to submit that 24 | work with modifications, whether created in whole or in part 25 | by me, under the same open source license (unless I am 26 | permitted to submit under a different license), as indicated 27 | in the file; or 28 | 29 | (c) The contribution was provided directly to me by some other 30 | person who certified (a), (b) or (c) and I have not modified 31 | it. 32 | 33 | (d) I understand and agree that this project and the contribution 34 | are public and that a record of the contribution (including all 35 | personal information I submit with it, including my sign-off) is 36 | maintained indefinitely and may be redistributed consistent with 37 | this project or the open source license(s) involved. 38 | -------------------------------------------------------------------------------- /src/error.rs: -------------------------------------------------------------------------------- 1 | use failure::{self, Backtrace, Context, Fail}; 2 | use std::fmt::{self, Display}; 3 | use std::result; 4 | 5 | /// A specialized [`Result`] type for this crate's operations. 6 | /// 7 | /// This is generally used to avoid writing out [Error] directly and 8 | /// is otherwise a direct mapping to [`Result`]. 9 | /// 10 | /// [`Result`]: https://doc.rust-lang.org/nightly/std/result/enum.Result.html 11 | /// [`Error`]: std.struct.Error.html 12 | pub type Result = result::Result; 13 | 14 | /// A list enumerating the categories of errors in this crate. 15 | /// 16 | /// This list is intended to grow over time and it is not recommended to 17 | /// exhaustively match against it. 18 | /// 19 | /// It is used with the [`Error`] struct. 20 | /// 21 | /// [`Error`]: std.struct.Error.html 22 | #[derive(Debug, Fail)] 23 | pub enum ErrorKind { 24 | /// Any error not part of this list. 25 | #[fail(display = "Generic error.")] 26 | Other, 27 | } 28 | 29 | /// A specialized [`Error`] type for this crate's operations. 30 | /// 31 | /// [`Error`]: https://doc.rust-lang.org/nightly/std/error/trait.Error.html 32 | #[derive(Debug)] 33 | pub struct Error { 34 | inner: Context, 35 | } 36 | 37 | impl Error { 38 | /// Access the [`ErrorKind`] member. 39 | /// 40 | /// [`ErrorKind`]: enum.ErrorKind.html 41 | pub fn kind(&self) -> &ErrorKind { 42 | &*self.inner.get_context() 43 | } 44 | } 45 | 46 | impl Fail for Error { 47 | fn cause(&self) -> Option<&dyn Fail> { 48 | self.inner.cause() 49 | } 50 | 51 | fn backtrace(&self) -> Option<&Backtrace> { 52 | self.inner.backtrace() 53 | } 54 | } 55 | 56 | impl Display for Error { 57 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 58 | Display::fmt(&self.inner, f) 59 | } 60 | } 61 | 62 | impl From for Error { 63 | fn from(kind: ErrorKind) -> Error { 64 | let inner = Context::new(kind); 65 | Error { inner } 66 | } 67 | } 68 | 69 | impl From> for Error { 70 | fn from(inner: Context) -> Error { 71 | Error { inner } 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # async-ready 2 | [![crates.io version][1]][2] [![build status][3]][4] 3 | [![downloads][5]][6] [![docs.rs docs][7]][8] 4 | 5 | Async readiness traits. Useful when implementing async state machines 6 | that can later be wrapped in dedicated futures. 7 | 8 | - [Documentation][8] 9 | - [Crates.io][2] 10 | - [Releases][releases] 11 | 12 | ## Examples 13 | __Basic usage__ 14 | ```rust 15 | #![feature(futures_api)] 16 | 17 | use std::pin::Pin; 18 | use std::task::{Context, Poll}; 19 | use futures::prelude::*; 20 | use async_ready::AsyncReady; 21 | use std::io; 22 | 23 | struct Fut; 24 | 25 | impl Future for Fut { 26 | type Output = (); 27 | fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { 28 | Poll::Ready(()) 29 | } 30 | } 31 | 32 | impl AsyncReady for Fut { 33 | type Ok = (); 34 | type Err = io::Error; 35 | 36 | fn poll_ready( 37 | mut self: Pin<&mut Self>, 38 | cx: &mut Context<'_>, 39 | ) -> Poll> { 40 | Poll::Ready(Ok(())) 41 | } 42 | } 43 | ``` 44 | 45 | ## Installation 46 | ```sh 47 | $ cargo add async-ready 48 | ``` 49 | 50 | ## Safety 51 | This crate uses ``#![deny(unsafe_code)]`` to ensure everything is implemented in 52 | 100% Safe Rust. 53 | 54 | ## Contributing 55 | Want to join us? Check out our ["Contributing" guide][contributing] and take a 56 | look at some of these issues: 57 | 58 | - [Issues labeled "good first issue"][good-first-issue] 59 | - [Issues labeled "help wanted"][help-wanted] 60 | 61 | ## References 62 | None. 63 | 64 | ## License 65 | [MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE) 66 | 67 | [1]: https://img.shields.io/crates/v/async-ready.svg?style=flat-square 68 | [2]: https://crates.io/crates/async-ready 69 | [3]: https://img.shields.io/travis/rustasync/async-ready/master.svg?style=flat-square 70 | [4]: https://travis-ci.org/rustasync/async-ready 71 | [5]: https://img.shields.io/crates/d/async-ready.svg?style=flat-square 72 | [6]: https://crates.io/crates/async-ready 73 | [7]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square 74 | [8]: https://docs.rs/async-ready 75 | 76 | [releases]: https://github.com/rustasync/async-ready/releases 77 | [contributing]: https://github.com/rustasync/async-ready/blob/master.github/CONTRIBUTING.md 78 | [good-first-issue]: https://github.com/rustasync/async-ready/labels/good%20first%20issue 79 | [help-wanted]: https://github.com/rustasync/async-ready/labels/help%20wanted 80 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | Contributions include code, documentation, answering user questions, running the 3 | project's infrastructure, and advocating for all types of users. 4 | 5 | The project welcomes all contributions from anyone willing to work in good faith 6 | with other contributors and the community. No contribution is too small and all 7 | contributions are valued. 8 | 9 | This guide explains the process for contributing to the project's GitHub 10 | Repository. 11 | 12 | - [Code of Conduct](#code-of-conduct) 13 | - [Bad Actors](#bad-actors) 14 | - [Developer Certificate of Origin](#developer-certificate-of-origin) 15 | 16 | ## Code of Conduct 17 | The project has a [Code of Conduct](./CODE_OF_CONDUCT.md) that *all* 18 | contributors are expected to follow. This code describes the *minimum* behavior 19 | expectations for all contributors. 20 | 21 | As a contributor, how you choose to act and interact towards your 22 | fellow contributors, as well as to the community, will reflect back not only 23 | on yourself but on the project as a whole. The Code of Conduct is designed and 24 | intended, above all else, to help establish a culture within the project that 25 | allows anyone and everyone who wants to contribute to feel safe doing so. 26 | 27 | Should any individual act in any way that is considered in violation of the 28 | [Code of Conduct](./CODE_OF_CONDUCT.md), corrective actions will be taken. It is 29 | possible, however, for any individual to *act* in such a manner that is not in 30 | violation of the strict letter of the Code of Conduct guidelines while still 31 | going completely against the spirit of what that Code is intended to accomplish. 32 | 33 | Open, diverse, and inclusive communities live and die on the basis of trust. 34 | Contributors can disagree with one another so long as they trust that those 35 | disagreements are in good faith and everyone is working towards a common 36 | goal. 37 | 38 | ## Bad Actors 39 | All contributors to tacitly agree to abide by both the letter and 40 | spirit of the [Code of Conduct](./CODE_OF_CONDUCT.md). Failure, or 41 | unwillingness, to do so will result in contributions being respectfully 42 | declined. 43 | 44 | A *bad actor* is someone who repeatedly violates the *spirit* of the Code of 45 | Conduct through consistent failure to self-regulate the way in which they 46 | interact with other contributors in the project. In doing so, bad actors 47 | alienate other contributors, discourage collaboration, and generally reflect 48 | poorly on the project as a whole. 49 | 50 | Being a bad actor may be intentional or unintentional. Typically, unintentional 51 | bad behavior can be easily corrected by being quick to apologize and correct 52 | course *even if you are not entirely convinced you need to*. Giving other 53 | contributors the benefit of the doubt and having a sincere willingness to admit 54 | that you *might* be wrong is critical for any successful open collaboration. 55 | 56 | Don't be a bad actor. 57 | 58 | ## Developer Certificate of Origin 59 | All contributors must read and agree to the [Developer Certificate of 60 | Origin (DCO)](../CERTIFICATE). 61 | 62 | The DCO allows us to accept contributions from people to the project, similarly 63 | to how a license allows us to distribute our code. 64 | -------------------------------------------------------------------------------- /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of 9 | experience, 10 | education, socio-economic status, nationality, personal appearance, race, 11 | religion, or sexual identity and orientation. 12 | 13 | ## Our Standards 14 | 15 | Examples of behavior that contributes to creating a positive environment 16 | include: 17 | 18 | - Using welcoming and inclusive language 19 | - Being respectful of differing viewpoints and experiences 20 | - Gracefully accepting constructive criticism 21 | - Focusing on what is best for the community 22 | - Showing empathy towards other community members 23 | 24 | Examples of unacceptable behavior by participants include: 25 | 26 | - The use of sexualized language or imagery and unwelcome sexual attention or 27 | advances 28 | - Trolling, insulting/derogatory comments, and personal or political attacks 29 | - Public or private harassment 30 | - Publishing others' private information, such as a physical or electronic 31 | address, without explicit permission 32 | - Other conduct which could reasonably be considered inappropriate in a 33 | professional setting 34 | 35 | 36 | ## Our Responsibilities 37 | 38 | Project maintainers are responsible for clarifying the standards of acceptable 39 | behavior and are expected to take appropriate and fair corrective action in 40 | response to any instances of unacceptable behavior. 41 | 42 | Project maintainers have the right and responsibility to remove, edit, or 43 | reject comments, commits, code, wiki edits, issues, and other contributions 44 | that are not aligned to this Code of Conduct, or to ban temporarily or 45 | permanently any contributor for other behaviors that they deem inappropriate, 46 | threatening, offensive, or harmful. 47 | 48 | ## Scope 49 | 50 | This Code of Conduct applies both within project spaces and in public spaces 51 | when an individual is representing the project or its community. Examples of 52 | representing a project or community include using an official project e-mail 53 | address, posting via an official social media account, or acting as an appointed 54 | representative at an online or offline event. Representation of a project may be 55 | further defined and clarified by project maintainers. 56 | 57 | ## Enforcement 58 | 59 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 60 | reported by contacting the project team at yoshuawuyts@gmail.com, or through 61 | IRC. All complaints will be reviewed and investigated and will result in a 62 | response that is deemed necessary and appropriate to the circumstances. The 63 | project team is obligated to maintain confidentiality with regard to the 64 | reporter of an incident. 65 | Further details of specific enforcement policies may be posted separately. 66 | 67 | Project maintainers who do not follow or enforce the Code of Conduct in good 68 | faith may face temporary or permanent repercussions as determined by other 69 | members of the project's leadership. 70 | 71 | ## Attribution 72 | 73 | This Code of Conduct is adapted from the Contributor Covenant, version 1.4, 74 | available at 75 | https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 76 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #![forbid(unsafe_code, future_incompatible)] 2 | #![deny(missing_debug_implementations, bad_style)] 3 | #![deny(missing_docs)] 4 | #![cfg_attr(test, deny(warnings))] 5 | 6 | //! Async readiness traits. Useful when implementing async state machines 7 | //! that can later be wrapped in dedicated futures. 8 | //! 9 | //! ## Example 10 | //! 11 | //! ```rust 12 | //! 13 | //! use std::pin::Pin; 14 | //! use std::task::{Context, Poll}; 15 | //! use futures::prelude::*; 16 | //! use async_ready::AsyncReady; 17 | //! use std::io; 18 | //! 19 | //! struct Fut; 20 | //! 21 | //! impl Future for Fut { 22 | //! type Output = (); 23 | //! fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll { 24 | //! Poll::Ready(()) 25 | //! } 26 | //! } 27 | //! 28 | //! impl AsyncReady for Fut { 29 | //! type Ok = (); 30 | //! type Err = io::Error; 31 | //! 32 | //! fn poll_ready( 33 | //! mut self: Pin<&mut Self>, 34 | //! cx: &mut Context<'_>, 35 | //! ) -> Poll> { 36 | //! Poll::Ready(Ok(())) 37 | //! } 38 | //! } 39 | //! ``` 40 | 41 | use std::pin::Pin; 42 | use std::task::{Context, Poll}; 43 | 44 | /// Determine if the underlying API can be written to. 45 | pub trait AsyncWriteReady { 46 | /// The type of successful values yielded by this trait. 47 | type Ok; 48 | 49 | /// The type of failures yielded by this trait. 50 | type Err: std::error::Error + Send + Sync; 51 | 52 | /// Check if the underlying API can be written to. 53 | fn poll_write_ready( 54 | self: Pin<&mut Self>, 55 | cx: &mut Context<'_>, 56 | ) -> Poll>; 57 | 58 | /// A convenience for calling `AsyncWriteReady::poll_write_ready` on `Unpin` types. 59 | fn poll_write_ready_unpin( 60 | &mut self, 61 | cx: &mut Context<'_>, 62 | ) -> Poll> 63 | where 64 | Self: Unpin + Sized, 65 | { 66 | Pin::new(self).poll_write_ready(cx) 67 | } 68 | } 69 | 70 | /// Determine if the underlying API can be read from. 71 | pub trait AsyncReadReady { 72 | /// The type of successful values yielded by this trait. 73 | type Ok; 74 | 75 | /// The type of failures yielded by this trait. 76 | type Err: std::error::Error + Send + Sync; 77 | 78 | /// Check if the underlying API can be read from. 79 | fn poll_read_ready( 80 | self: Pin<&mut Self>, 81 | cx: &mut Context<'_>, 82 | ) -> Poll>; 83 | 84 | /// A convenience for calling `AsyncReadReady::poll_read_ready` on `Unpin` types. 85 | fn poll_read_ready_unpin( 86 | &mut self, 87 | cx: &mut Context<'_>, 88 | ) -> Poll> 89 | where 90 | Self: Unpin + Sized, 91 | { 92 | Pin::new(self).poll_read_ready(cx) 93 | } 94 | } 95 | 96 | /// Determine if a struct is async-ready to yield futures. 97 | /// 98 | /// This is useful when a `Stream` borrows an internal struct, and the internal 99 | /// struct is in charge of establishing the io channel. That way the stream and 100 | /// the readiness can be decoupled. 101 | /// 102 | /// Once the IO channel is async-ready, `poll_async-ready` should always return 103 | /// `Poll::Ready`. 104 | pub trait AsyncReady { 105 | /// The type of successful values yielded by this trait. 106 | type Ok; 107 | 108 | /// The type of failures yielded by this trait. 109 | type Err: std::error::Error + Send + Sync; 110 | 111 | /// Check if the stream can be read from. 112 | fn poll_ready( 113 | self: Pin<&mut Self>, 114 | cx: &mut Context<'_>, 115 | ) -> Poll>; 116 | 117 | /// A convenience for calling `AsyncReady::poll_ready` on `Unpin` types. 118 | fn poll_ready_unpin( 119 | &mut self, 120 | cx: &mut Context<'_>, 121 | ) -> Poll> 122 | where 123 | Self: Unpin + Sized, 124 | { 125 | Pin::new(self).poll_ready(cx) 126 | } 127 | } 128 | 129 | /// Extract an error from the underlying struct that isn't propagated through 130 | /// regular channels. 131 | /// 132 | /// This is common in `TcpListener` / `UdsStream` structs where this trait can 133 | /// be used to access the `SO_ERROR` option on the socket. 134 | /// 135 | /// Both `Ok` and `Err` are error types. If no error exists `take_error` should 136 | /// return `Ok(None)`. 137 | pub trait TakeError { 138 | /// The type of successful values yielded by this trait. 139 | type Ok: std::error::Error + Send + Sync; 140 | 141 | /// The type of failures yielded by this trait. 142 | type Err: std::error::Error + Send + Sync; 143 | 144 | /// Return an underlying error value of the struct. 145 | fn take_error(&self) -> Result, Self::Err>; 146 | } 147 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 2019-03-08, Version 2.0.0 2 | ### Commits 3 | - [[`d33a453343`](https://github.com/rustasync/async-ready/commit/d33a453343bf2e51ee105aa35b49fb62853b626d)] (cargo-release) version 2.0.0 (Yoshua Wuyts) 4 | - [[`7b08b12253`](https://github.com/rustasync/async-ready/commit/7b08b122534873b1df5cae8875d26d580288e9ca)] no mut (Yoshua Wuyts) 5 | - [[`f083245279`](https://github.com/rustasync/async-ready/commit/f083245279100d04900c80feb70cb80c623a9e9a)] (cargo-release) version 1.0.1 (Yoshua Wuyts) 6 | - [[`5a37d2d1a3`](https://github.com/rustasync/async-ready/commit/5a37d2d1a30b9d7a8f1cfb38775b71b32f1c135b)] fix tagline (Yoshua Wuyts) 7 | - [[`858dbdbc5b`](https://github.com/rustasync/async-ready/commit/858dbdbc5ba0900faf6d5c68273a41e896b8a93c)] rename to async-ready (Yoshua Wuyts) 8 | - [[`c3a1d4df60`](https://github.com/rustasync/async-ready/commit/c3a1d4df60afb62023be7aad7678a72b4cb4f9e2)] Update changelog (Yoshua Wuyts) 9 | 10 | ### Stats 11 | ```diff 12 | CHANGELOG.md | 27 +++++++++++++++++++++------ 13 | Cargo.toml | 12 ++++++------ 14 | README.md | 32 +++++++++++++++++--------------- 15 | src/lib.rs | 23 ++++++++++++++--------- 16 | 4 files changed, 58 insertions(+), 36 deletions(-) 17 | ``` 18 | 19 | 20 | ## 2019-03-08, Version 2.0.0 21 | ### Commits 22 | - [[`d33a453343`](https://github.com/rustasync/async-ready/commit/d33a453343bf2e51ee105aa35b49fb62853b626d)] (cargo-release) version 2.0.0 (Yoshua Wuyts) 23 | - [[`7b08b12253`](https://github.com/rustasync/async-ready/commit/7b08b122534873b1df5cae8875d26d580288e9ca)] no mut (Yoshua Wuyts) 24 | - [[`f083245279`](https://github.com/rustasync/async-ready/commit/f083245279100d04900c80feb70cb80c623a9e9a)] (cargo-release) version 1.0.1 (Yoshua Wuyts) 25 | - [[`5a37d2d1a3`](https://github.com/rustasync/async-ready/commit/5a37d2d1a30b9d7a8f1cfb38775b71b32f1c135b)] fix tagline (Yoshua Wuyts) 26 | - [[`858dbdbc5b`](https://github.com/rustasync/async-ready/commit/858dbdbc5ba0900faf6d5c68273a41e896b8a93c)] rename to async-ready (Yoshua Wuyts) 27 | - [[`c3a1d4df60`](https://github.com/rustasync/async-ready/commit/c3a1d4df60afb62023be7aad7678a72b4cb4f9e2)] Update changelog (Yoshua Wuyts) 28 | 29 | ### Stats 30 | ```diff 31 | CHANGELOG.md | 27 +++++++++++++++++++++------ 32 | Cargo.toml | 12 ++++++------ 33 | README.md | 32 +++++++++++++++++--------------- 34 | src/lib.rs | 23 ++++++++++++++--------- 35 | 4 files changed, 58 insertions(+), 36 deletions(-) 36 | ``` 37 | 38 | 39 | ## 2019-03-08, Version 2.0.0 40 | ### Commits 41 | - [[`d33a453343`](https://github.com/yoshuawuyts/async-ready/commit/d33a453343bf2e51ee105aa35b49fb62853b626d)] (cargo-release) version 2.0.0 (Yoshua Wuyts) 42 | - [[`7b08b12253`](https://github.com/yoshuawuyts/async-ready/commit/7b08b122534873b1df5cae8875d26d580288e9ca)] no mut (Yoshua Wuyts) 43 | - [[`f083245279`](https://github.com/yoshuawuyts/async-ready/commit/f083245279100d04900c80feb70cb80c623a9e9a)] (cargo-release) version 1.0.1 (Yoshua Wuyts) 44 | - [[`5a37d2d1a3`](https://github.com/yoshuawuyts/async-ready/commit/5a37d2d1a30b9d7a8f1cfb38775b71b32f1c135b)] fix tagline (Yoshua Wuyts) 45 | - [[`858dbdbc5b`](https://github.com/yoshuawuyts/async-ready/commit/858dbdbc5ba0900faf6d5c68273a41e896b8a93c)] rename to async-ready (Yoshua Wuyts) 46 | - [[`c3a1d4df60`](https://github.com/yoshuawuyts/async-ready/commit/c3a1d4df60afb62023be7aad7678a72b4cb4f9e2)] Update changelog (Yoshua Wuyts) 47 | 48 | ### Stats 49 | ```diff 50 | CHANGELOG.md | 27 +++++++++++++++++++++------ 51 | Cargo.toml | 12 ++++++------ 52 | README.md | 32 +++++++++++++++++--------------- 53 | src/lib.rs | 23 ++++++++++++++--------- 54 | 4 files changed, 58 insertions(+), 36 deletions(-) 55 | ``` 56 | 57 | 58 | ## 2019-03-07, Version 1.1.0 59 | ### Commits 60 | - [[`36ee5ddeb8`](https://github.com/yoshuawuyts/async-ready/commit/36ee5ddeb8e72af386ee9a17351eeae309e3c98e)] (cargo-release) version 1.1.0 (Yoshua Wuyts) 61 | - [[`21746f6bb6`](https://github.com/yoshuawuyts/async-ready/commit/21746f6bb6019583b362b98b8090ca05c4ffe136)] add TakeError (Yoshua Wuyts) 62 | - [[`6014621dbe`](https://github.com/yoshuawuyts/async-ready/commit/6014621dbeb33f7f53ea0517cc59d40a3f030dde)] Update changelog (Yoshua Wuyts) 63 | 64 | ### Stats 65 | ```diff 66 | CHANGELOG.md | 15 +++++++++++++++ 67 | Cargo.toml | 2 +- 68 | src/lib.rs | 25 ++++++++++++++++++++++--- 69 | 3 files changed, 38 insertions(+), 4 deletions(-) 70 | ``` 71 | 72 | 73 | ## 2019-03-07, Version 1.0.2 74 | ### Commits 75 | - [[`98cecf5a32`](https://github.com/yoshuawuyts/async-ready/commit/98cecf5a32491a3d9fb238954ba6adbb619f1cf6)] (cargo-release) version 1.0.2 (Yoshua Wuyts) 76 | - [[`ab5beaa174`](https://github.com/yoshuawuyts/async-ready/commit/ab5beaa174a79cdea95bfbbc640909c0dcf740f8)] fix mutability (Yoshua Wuyts) 77 | - [[`38271c0725`](https://github.com/yoshuawuyts/async-ready/commit/38271c0725a0cd27d2faffd5ea943c74e74bb718)] Update changelog (Yoshua Wuyts) 78 | 79 | ### Stats 80 | ```diff 81 | CHANGELOG.md | 31 +++++++++++++++++++++++++++++++ 82 | Cargo.toml | 2 +- 83 | src/lib.rs | 8 ++++---- 84 | 3 files changed, 36 insertions(+), 5 deletions(-) 85 | ``` 86 | 87 | 88 | ## 2019-03-07, Version 1.0.1 89 | ### Commits 90 | - [[`455bd12a1a`](https://github.com/yoshuawuyts/async-ready/commit/455bd12a1aeac3deae4c8432050b69eced51b956)] (cargo-release) version 1.0.1 (Yoshua Wuyts) 91 | - [[`331b94abd0`](https://github.com/yoshuawuyts/async-ready/commit/331b94abd01c5848e51584ebf3ce5684cf08dd02)] tweak desc (Yoshua Wuyts) 92 | - [[`9ea6f9f059`](https://github.com/yoshuawuyts/async-ready/commit/9ea6f9f0594e56261e46261b08ccfdebf7012299)] . (Yoshua Wuyts) 93 | 94 | ### Stats 95 | ```diff 96 | .github/CODE_OF_CONDUCT.md | 75 ++++++++++++- 97 | .github/CONTRIBUTING.md | 63 ++++++++++- 98 | .github/ISSUE_TEMPLATE.md | 9 +- 99 | .github/ISSUE_TEMPLATE/bug_report.md | 23 ++++- 100 | .github/ISSUE_TEMPLATE/feature_request.md | 43 +++++++- 101 | .github/ISSUE_TEMPLATE/question.md | 18 +++- 102 | .github/PULL_REQUEST_TEMPLATE.md | 21 +++- 103 | .github/stale.yml | 17 +++- 104 | .gitignore | 7 +- 105 | .travis.yml | 13 ++- 106 | CERTIFICATE | 37 ++++++- 107 | Cargo.toml | 17 +++- 108 | LICENSE-APACHE | 190 +++++++++++++++++++++++++++++++- 109 | LICENSE-MIT | 21 +++- 110 | README.md | 75 ++++++++++++- 111 | rustfmt.toml | 2 +- 112 | src/error.rs | 73 ++++++++++++- 113 | src/lib.rs | 80 +++++++++++++- 114 | tests/test.rs | 0 115 | 19 files changed, 784 insertions(+) 116 | ``` 117 | 118 | 119 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | Copyright 2019 Yoshua Wuyts 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | --------------------------------------------------------------------------------