futures-enum 0.1.8

#[derive(Future, Stream, Sink, AsyncRead, AsyncWrite)] for enums.
Documentation

futures-enum

Build Status version documentation license

#[derive(Future, Stream, Sink, AsyncRead, AsyncWrite, AsyncSeek, AsyncBufRead)] for enums.

Usage

Add this to your Cargo.toml:

[dependencies]
futures-enum = "0.1.8"

The current futures-enum requires Rust 1.36 or later.

Examples

use futures::future::{self, Future};
use futures_enum::*;

#[derive(Future, Stream, Sink, AsyncRead, AsyncWrite, AsyncSeek, AsyncBufRead)]
enum Either<A, B> {
    A(A),
    B(B),
}

fn foo(x: i32) -> impl Future<Output = i32> {
    if x < 0 {
        Either::A(future::lazy(|_| 1))
    } else {
        Either::B(future::ready(x))
    }
}

See auto_enums for how to automate patterns like this.

futures-enum works well even if the dependency contains only sub-crates such as futures-core, futures-util, etc.

Supported traits

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.