[][src]Struct futures::compat::Compat

#[must_use = "futures do nothing unless polled"]
pub struct Compat<T, Sp> { /* fields omitted */ }

Converts a futures 0.3 TryFuture, TryStream or Sink into a futures 0.1 Future, Stream or Sink and vice versa.

Methods

impl<T, Sp> Compat<T, Sp>
[src]

Returns the inner item.

Trait Implementations

impl<St> Stream for Compat<St, ()> where
    St: Stream
[src]

Values yielded by the stream.

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more

impl<Fut> Future for Compat<Fut, ()> where
    Fut: Future
[src]

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

The result of the Future.

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

impl<T, Sp> Debug for Compat<T, Sp> where
    Sp: Debug,
    T: Debug
[src]

Formats the value using the given formatter. Read more

impl<Fut, Sp> Future for Compat<Fut, Sp> where
    Fut: TryFuture + Unpin,
    Sp: Spawn
[src]

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

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

Query this future to see if its value has become available, registering interest if it is not. Read more

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

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

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

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

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

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

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

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

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

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

Same as join, but with more futures.

Same as join, but with more futures.

Same as join, but with more futures.

Convert this future into a single element stream. Read more

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

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

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

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

Catches unwinding panics while polling the future. Read more

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

impl<T, E> Sink for Compat<T, E> where
    E: Spawn,
    T: Sink + Unpin
[src]

The type of value that the sink accepts.

The type of value produced by the sink when an error occurs.

Begin the process of sending a value to the sink. Read more

Flush all output from this sink, if necessary. Read more

A method to indicate that no more values will ever be pushed into this sink. Read more

Creates a new object which will produce a synchronous sink. Read more

Composes a function in front of the sink. Read more

Composes a function in front of the sink. Read more

Transforms the error returned by the sink.

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

Adds a fixed-size buffer to the current sink. Read more

Fanout items to multiple sinks. Read more

A future that completes when the sink has finished processing all pending requests. Read more

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

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

impl<St, Sp> Stream for Compat<St, Sp> where
    Sp: Spawn,
    St: TryStream + Unpin
[src]

The type of item this stream will yield on success.

The type of error this stream may generate.

Attempt to pull out the next value of this stream, returning None if the stream is finished. Read more

Important traits for Wait<S>

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

Converts this stream into a Future. Read more

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Important traits for &'a mut I

Borrows a stream, rather than consuming it. Read more

Catches unwinding panics while polling the stream. Read more

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

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

Deprecated

: functionality provided by select now

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

An adapter for zipping two streams together. Read more

Adapter for chaining two stream. Read more

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

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

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

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

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

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

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

Auto Trait Implementations

impl<T, Sp> Send for Compat<T, Sp> where
    Sp: Send,
    T: Send

impl<T, Sp> Sync for Compat<T, Sp> where
    Sp: Sync,
    T: Sync

Blanket Implementations

impl<T> From for T
[src]

Performs the conversion.

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

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

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

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

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

Performs the conversion.

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

Important traits for &'a mut I

Immutably borrows from an owned value. Read more

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

Important traits for &'a mut I

Mutably borrows from an owned value. Read more

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

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

impl<T> FutureExt for T where
    T: Future + ?Sized
[src]

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

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

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

Same as join, but with more futures. Read more

Same as join, but with more futures. Read more

Same as join, but with more futures. Read more

Convert this future into a single element stream. Read more

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

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

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

Do something with the output of a future before passing it on. Read more

Catches unwinding panics while polling the future. Read more

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

Wrap the future in a Box, pinning it.

Turns a Future into a TryFuture with Error = ().

Assigns the provided Spawn to be used when spawning tasks from within the future. Read more

A convenience for calling Future::poll on Unpin future types.

impl<F, T, E> TryFuture for F where
    F: Future<Output = Result<T, E>>, 
[src]

The type of successful values yielded by this future

The type of failures yielded by this future

Poll this TryFuture as if it were a Future. Read more

impl<Fut> TryFutureExt for Fut where
    Fut: TryFuture
[src]

Flattens the execution of this future when the successful result of this future is a [Sink]. Read more

Maps this future's success value to a different value. Read more

Maps this future's error value to a different value. Read more

Maps this future's Error to a new error type using the Into trait. Read more

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more

Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more

Unwraps this future's ouput, producing a future with this future's Ok type as its Output type. Read more

Wraps a [TryFuture] into a future compatable with libraries using futures 0.1 future definitons. Requires the compat feature to enable. Read more

Wraps a [TryFuture] into a type that implements Future. Read more

Joins the result of two futures, waiting for them both to complete or for one to produce an error. Read more

Same as try_join, but with more futures. Read more

Same as try_join, but with more futures. Read more

Same as try_join, but with more futures. Read more

impl<T> StreamExt for T where
    T: Stream + ?Sized
[src]

Creates a future that resolves to the next item in the stream. Read more

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is [None]. Read more

Maps this stream's items to a different type, returning a new stream of the resulting type. Read more

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

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

Computes from this stream's items new items of a different type using an asynchronous closure. Read more

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

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

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

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

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

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

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

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more

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

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

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

Important traits for &'a mut I

Borrows a stream, rather than consuming it. Read more

Catches unwinding panics while polling the stream. Read more

Wrap the stream in a Box, pinning it.

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

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

An adapter for zipping two streams together. Read more

Adapter for chaining two stream. Read more

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

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

This combinator will attempt to pull items from both streams. Each stream will be polled in a round-robin fashion, and whenever a stream is ready to yield an item that item is yielded. Read more

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

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

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

Important traits for Either<L, R>

Wrap this stream in an Either stream, making it the left-hand variant of that Either. Read more

Important traits for Either<L, R>

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

A convenience method for calling [Stream::poll_next] on [Unpin] stream types. Read more

impl<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>>, 
[src]

The type of successful values yielded by this future

The type of failures yielded by this future

Poll this TryStream as if it were a Stream. Read more

impl<S> TryStreamExt for S where
    S: TryStream
[src]

Wraps the current stream in a new stream which converts the error type into the one provided. Read more

Wraps the current stream in a new stream which maps the success value using the provided closure. Read more

Wraps the current stream in a new stream which maps the error value using the provided closure. Read more

Wraps a [TryStream] into a type that implements Stream Read more

Creates a future that attempts to resolve the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

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

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

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available, exiting as soon as an error occurs. Read more

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

Attempt to filter the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

Attempt to execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

Attempt to execute several futures from a stream concurrently. Read more

Wraps a [TryStream] into a stream compatible with libraries using futures 0.1 Stream. Requires the compat feature to be enabled. ``` #![feature(async_await, await_macro, futures_api)] use futures::future::{FutureExt, TryFutureExt}; use futures::spawn; use futures::compat::TokioDefaultSpawner; # let (tx, rx) = futures::channel::oneshot::channel(); Read more

impl<Fut> Future01CompatExt for Fut where
    Fut: Future
[src]

Converts a futures 0.1 Future<Item = T, Error = E> into a futures 0.3 Future<Output = Result<T, E>>. Read more

impl<St> Stream01CompatExt for St where
    St: Stream
[src]

Converts a futures 0.1 Stream<Item = T, Error = E> into a futures 0.3 Stream<Item = Result<T, E>>. Read more

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

The future that this type can be converted into.

The item that the future may resolve with.

The error that the future may resolve with.

Consumes this object and produces a future.