#async #ready_state #poll_ready

async-ready

Async readiness traits

6 stable releases

✓ Uses Rust 2018 edition

3.0.0 May 15, 2019
2.1.0 Apr 16, 2019
2.0.1 Apr 15, 2019
2.0.0 Mar 8, 2019
1.0.1 Mar 8, 2019

#50 in Asynchronous

Download history 83/week @ 2019-03-26 168/week @ 2019-04-02 255/week @ 2019-04-09 306/week @ 2019-04-16 277/week @ 2019-04-23 206/week @ 2019-04-30 267/week @ 2019-05-07 390/week @ 2019-05-14 404/week @ 2019-05-21 308/week @ 2019-05-28 409/week @ 2019-06-04 379/week @ 2019-06-11 445/week @ 2019-06-18 640/week @ 2019-06-25 530/week @ 2019-07-02

977 downloads per month
Used in 13 crates (1 directly)

MIT/Apache

14KB
104 lines

async-ready

crates.io version build status downloads docs.rs docs

Async readiness traits. Useful when implementing async state machines that can later be wrapped in dedicated futures.

Examples

Basic usage

#![feature(futures_api)]

use std::pin::Pin;
use std::task::{Context, Poll};
use futures::prelude::*;
use async_ready::AsyncReady;
use std::io;

struct Fut;

impl Future for Fut {
  type Output = ();
  fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
    Poll::Ready(())
  }
}

impl AsyncReady for Fut {
  type Ok = ();
  type Err = io::Error;

  fn poll_ready(
    mut self: Pin<&mut Self>,
    cx: &mut Context<'_>,
  ) -> Poll<Result<Self::Ok, Self::Err>> {
    Poll::Ready(Ok(()))
  }
}

Installation

$ cargo add async-ready

Safety

This crate uses #![deny(unsafe_code)] to ensure everything is implemented in 100% Safe Rust.

Contributing

Want to join us? Check out our "Contributing" guide and take a look at some of these issues:

References

None.

License

MIT OR Apache-2.0

No runtime deps