futures-enum 0.1.12

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

futures-enum

crates-badge docs-badge license-badge rustc-badge

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

Usage

Add this to your Cargo.toml:

[dependencies]
futures-enum = "0.1.12"
futures = "0.3"

The current futures-enum requires Rust 1.36 or later.

Examples

use futures_enum::*;
use std::future::Future;

#[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(async { 1 })
    } else {
        Either::B(async move { x })
    }
}

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

See auto_enums crate for how to automate patterns like this.

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.