[][src]Enum futures::future::Either

pub enum Either<A, B> {
    A(A),
    B(B),
}

Combines two different futures yielding the same item and error types into a single type.

Variants

A(A)

First branch of the type

B(B)

Second branch of the type

Methods

impl<T, A, B> Either<(T, A), (T, B)>[src]

pub fn split(self) -> (T, Either<A, B>)[src]

Splits out the homogeneous type from an either of tuples.

This method is typically useful when combined with the Future::select2 combinator.

Trait Implementations

impl<A, B> Future for Either<A, B> where
    A: Future,
    B: Future<Item = A::Item, Error = A::Error>, 
[src]

type Item = A::Item

The type of value that this future will resolved with if it is successful. Read more

type Error = A::Error

The type of error that this future will resolve with if it fails in a normal fashion. Read more

fn wait(self) -> Result<Self::Item, Self::Error> where
    Self: Sized
[src]

Block the current thread until this future is resolved. Read more

fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U,
    Self: Sized
[src]

Map this future's result to a different type, returning a new future of the resulting type. Read more

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E,
    Self: Sized
[src]

Map this future's error to a different error, returning a new future. Read more

fn from_err<E: From<Self::Error>>(self) -> FromErr<Self, E> where
    Self: Sized
[src]

Map this future's error to any error implementing From for this future's Error, returning a new future. Read more

fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    F: FnOnce(Result<Self::Item, Self::Error>) -> B,
    B: IntoFuture,
    Self: Sized
[src]

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    F: FnOnce(Self::Item) -> B,
    B: IntoFuture<Error = Self::Error>,
    Self: Sized
[src]

Execute another future after this one has resolved successfully. Read more

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    F: FnOnce(Self::Error) -> B,
    B: IntoFuture<Item = Self::Item>,
    Self: Sized
[src]

Execute another future if this one resolves with an error. Read more

fn select<B>(self, other: B) -> Select<Self, B::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>,
    Self: Sized
[src]

Waits for either one of two futures to complete. Read more

fn select2<B>(self, other: B) -> Select2<Self, B::Future> where
    B: IntoFuture,
    Self: Sized
[src]

Waits for either one of two differently-typed futures to complete. Read more

fn join<B>(self, other: B) -> Join<Self, B::Future> where
    B: IntoFuture<Error = Self::Error>,
    Self: Sized
[src]

Joins the result of two futures, waiting for them both to complete. Read more

fn join3<B, C>(self, b: B, c: C) -> Join3<Self, B::Future, C::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    Self: Sized
[src]

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, B::Future, C::Future, D::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    Self: Sized
[src]

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, B::Future, C::Future, D::Future, E::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>,
    Self: Sized
[src]

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self> where
    Self: Sized
[src]

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>,
    Self: Sized
[src]

Flatten the execution of this future when the successful result of this future is itself another future. Read more

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream<Error = Self::Error>,
    Self: Sized
[src]

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn fuse(self) -> Fuse<Self> where
    Self: Sized
[src]

Fuse a future such that poll will never again be called once it has completed. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item),
    Self: Sized
[src]

Do something with the item of a future, passing it on. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: Sized + UnwindSafe
[src]

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self> where
    Self: Sized
[src]

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

impl<A, B> Stream for Either<A, B> where
    A: Stream,
    B: Stream<Item = A::Item, Error = A::Error>, 
[src]

type Item = A::Item

The type of item this stream will yield on success.

type Error = A::Error

The type of error this stream may generate.

Important traits for Wait<S>
fn wait(self) -> Wait<Self> where
    Self: Sized
[src]

Creates an iterator which blocks the current thread until each item of this stream is resolved. Read more

fn into_future(self) -> StreamFuture<Self> where
    Self: Sized
[src]

Converts this stream into a Future. Read more

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> U,
    Self: Sized
[src]

Converts a stream of type T to a stream of type U. Read more

fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> U,
    Self: Sized
[src]

Converts a stream of error type T to a stream of error type U. Read more

fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool,
    Self: Sized
[src]

Filters the values produced by this stream according to the provided predicate. Read more

fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>,
    Self: Sized
[src]

Filters the values produced by this stream while simultaneously mapping them to a different type. Read more

fn then<F, U>(self, f: F) -> Then<Self, F, U> where
    F: FnMut(Result<Self::Item, Self::Error>) -> U,
    U: IntoFuture,
    Self: Sized
[src]

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f. Read more

fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Error = Self::Error>,
    Self: Sized
[src]

Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more

fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
    F: FnMut(Self::Error) -> U,
    U: IntoFuture<Item = Self::Item>,
    Self: Sized
[src]

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more

fn collect(self) -> Collect<Self> where
    Self: Sized
[src]

Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more

fn concat2(self) -> Concat2<Self> where
    Self: Sized,
    Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default
[src]

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more

fn concat(self) -> Concat<Self> where
    Self: Sized,
    Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator
[src]

Deprecated since 0.1.14:

please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more

fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<Fut::Error>,
    Self: Sized
[src]

Execute an accumulating computation over a stream, collecting all the values into one final result. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error: From<Self::Error>,
    Self: Sized
[src]

Flattens a stream of streams into just one continuous stream. Read more

fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>,
    Self: Sized
[src]

Skip elements on this stream while the predicate provided resolves to true. Read more

fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>,
    Self: Sized
[src]

Take elements from this stream while the predicate provided resolves to true. Read more

fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Item = (), Error = Self::Error>,
    Self: Sized
[src]

Runs this stream to completion, executing the provided closure for each element on the stream. Read more

fn from_err<E: From<Self::Error>>(self) -> FromErr<Self, E> where
    Self: Sized
[src]

Map this stream's error to any error implementing From for this stream's Error, returning a new stream. Read more

fn take(self, amt: u64) -> Take<Self> where
    Self: Sized
[src]

Creates a new stream of at most amt items of the underlying stream. Read more

fn skip(self, amt: u64) -> Skip<Self> where
    Self: Sized
[src]

Creates a new stream which skips amt items of the underlying stream. Read more

fn fuse(self) -> Fuse<Self> where
    Self: Sized
[src]

Fuse a stream such that poll will never again be called once it has finished. Read more

fn by_ref(&mut self) -> &mut Self where
    Self: Sized
[src]

Borrows a stream, rather than consuming it. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: Sized + UnwindSafe
[src]

Catches unwinding panics while polling the stream. Read more

fn buffered(self, amt: usize) -> Buffered<Self> where
    Self::Item: IntoFuture<Error = Self::Error>,
    Self: Sized
[src]

An adaptor for creating a buffered list of pending futures. Read more

fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
    Self::Item: IntoFuture<Error = Self::Error>,
    Self: Sized
[src]

An adaptor for creating a buffered list of pending futures (unordered). Read more

fn merge<S>(self, other: S) -> Merge<Self, S> where
    S: Stream<Error = Self::Error>,
    Self: Sized
[src]

Deprecated:

functionality provided by select now

An adapter for merging the output of two streams. Read more

fn zip<S>(self, other: S) -> Zip<Self, S> where
    S: Stream<Error = Self::Error>,
    Self: Sized
[src]

An adapter for zipping two streams together. Read more

fn chain<S>(self, other: S) -> Chain<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>,
    Self: Sized
[src]

Adapter for chaining two stream. Read more

fn peekable(self) -> Peekable<Self> where
    Self: Sized
[src]

Creates a new stream which exposes a peek method. Read more

fn chunks(self, capacity: usize) -> Chunks<Self> where
    Self: Sized
[src]

An adaptor for chunking up items of the stream inside a vector. Read more

fn select<S>(self, other: S) -> Select<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>,
    Self: Sized
[src]

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. Read more

fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<S::SinkError>,
    Self: Sized
[src]

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
    Self: Sink + Sized
[src]

Splits this Stream + Sink object into separate Stream and Sink objects. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item),
    Self: Sized
[src]

Do something with each item of this stream, afterwards passing it on. Read more

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error),
    Self: Sized
[src]

Do something with the error of this stream, afterwards passing it on. Read more

impl<A: Debug, B: Debug> Debug for Either<A, B>[src]

Auto Trait Implementations

impl<A, B> Send for Either<A, B> where
    A: Send,
    B: Send

impl<A, B> Sync for Either<A, B> where
    A: Sync,
    B: Sync

Blanket Implementations

impl<F> IntoFuture for F where
    F: Future
[src]

type Future = F

The future that this type can be converted into.

type Item = <F as Future>::Item

The item that the future may resolve with.

type Error = <F as Future>::Error

The error that the future may resolve with.

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]