[][src]Struct futures::compat::Compat01As03

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

Converts a futures 0.1 Future, Stream, AsyncRead, or AsyncWrite object to a futures 0.3-compatible version,

Methods

impl<T> Compat01As03<T>
[src]

pub fn new(object: T) -> Compat01As03<T>
[src]

Wraps a futures 0.1 Future, Stream, AsyncRead, or AsyncWrite object in a futures 0.3-compatible wrapper.

Trait Implementations

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

type Output = Result<<Fut as Future>::Item, <Fut as Future>::Error>

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

futures in libcore are unstable

The result of the Future.

impl<R> AsyncRead for Compat01As03<R> where
    R: AsyncRead
[src]

fn poll_vectored_read(
    &mut self,
    lw: &LocalWaker,
    vec: &mut [&mut IoVec]
) -> Poll<Result<usize, Error>>
[src]

Attempt to read from the AsyncRead into vec using vectored IO operations. Read more

impl<T> Unpin for Compat01As03<T>
[src]

impl<T> Debug for Compat01As03<T> where
    T: Debug
[src]

impl<W> AsyncWrite for Compat01As03<W> where
    W: AsyncWrite
[src]

fn poll_vectored_write(
    &mut self,
    lw: &LocalWaker,
    vec: &[&IoVec]
) -> Poll<Result<usize, Error>>
[src]

Attempt to write bytes from vec into the object using vectored IO operations. Read more

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

type Item = Result<<St as Stream>::Item, <St as Stream>::Error>

Values yielded by the stream.

Auto Trait Implementations

impl<T> Send for Compat01As03<T> where
    T: Send

impl<T> !Sync for Compat01As03<T>

Blanket Implementations

impl<T> From for T
[src]

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

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

type Error = !

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

The type returned in the event of a conversion error.

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

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

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

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

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

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

The type returned in the event of a conversion error.

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

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

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

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnOnce(Self::Output) -> Fut,
    Fut: Future
[src]

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

fn join<Fut2>(self, other: Fut2) -> Join<Self, Fut2> where
    Fut2: Future
[src]

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

fn join3<Fut2, Fut3>(
    self,
    future2: Fut2,
    future3: Fut3
) -> Join3<Self, Fut2, Fut3> where
    Fut2: Future,
    Fut3: Future
[src]

Same as join, but with more futures. Read more

fn join4<Fut2, Fut3, Fut4>(
    self,
    future2: Fut2,
    future3: Fut3,
    future4: Fut4
) -> Join4<Self, Fut2, Fut3, Fut4> where
    Fut2: Future,
    Fut3: Future + Future,
    Fut4: Future
[src]

Same as join, but with more futures. Read more

fn join5<Fut2, Fut3, Fut4, Fut5>(
    self,
    future2: Fut2,
    future3: Fut3,
    future4: Fut4,
    future5: Fut5
) -> Join5<Self, Fut2, Fut3, Fut4, Fut5> where
    Fut2: Future,
    Fut3: Future + Future,
    Fut4: Future,
    Fut5: Future
[src]

Same as join, but with more futures. Read more

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

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Output: Future
[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::Output: Stream
[src]

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

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

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

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

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

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

Catches unwinding panics while polling the future. Read more

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

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

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
[src]

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

fn boxed(self) -> Pin<Box<Self>>
[src]

Wrap the future in a Box, pinning it.

fn unit_error(self) -> UnitError<Self>
[src]

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

fn poll_unpin(&mut self, lw: &LocalWaker) -> Poll<Self::Output> where
    Self: Unpin
[src]

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]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

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

fn flatten_sink(self) -> FlattenSink<Self, Self::Ok> where
    Self::Ok: Sink,
    <Self::Ok as Sink>::SinkError == Self::Error
[src]

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

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
    F: FnOnce(Self::Ok) -> T, 
[src]

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

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

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

fn err_into<E>(self) -> ErrInto<Self, E> where
    Self::Error: Into<E>, 
[src]

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

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
    F: FnOnce(Self::Ok) -> Fut,
    Fut: TryFuture<Error = Self::Error>, 
[src]

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

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
    F: FnOnce(Self::Error) -> Fut,
    Fut: TryFuture<Ok = Self::Ok>, 
[src]

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

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
    F: FnOnce(Self::Error) -> Self::Ok
[src]

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

Important traits for Compat<R>
fn compat(self) -> Compat<Self> where
    Self: Unpin
[src]

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

fn into_future(self) -> IntoFuture<Self>
[src]

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

fn try_join<Fut2>(self, other: Fut2) -> TryJoin<Self, Fut2> where
    Fut2: TryFuture<Error = Self::Error>, 
[src]

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

fn try_join3<Fut2, Fut3>(
    self,
    future2: Fut2,
    future3: Fut3
) -> TryJoin3<Self, Fut2, Fut3> where
    Fut2: TryFuture<Error = Self::Error>,
    Fut3: TryFuture<Error = Self::Error>, 
[src]

Same as try_join, but with more futures. Read more

fn try_join4<Fut2, Fut3, Fut4>(
    self,
    future2: Fut2,
    future3: Fut3,
    future4: Fut4
) -> TryJoin4<Self, Fut2, Fut3, Fut4> where
    Fut2: TryFuture<Error = Self::Error>,
    Fut3: TryFuture<Error = Self::Error>,
    Fut4: TryFuture<Error = Self::Error>, 
[src]

Same as try_join, but with more futures. Read more

fn try_join5<Fut2, Fut3, Fut4, Fut5>(
    self,
    future2: Fut2,
    future3: Fut3,
    future4: Fut4,
    future5: Fut5
) -> TryJoin5<Self, Fut2, Fut3, Fut4, Fut5> where
    Fut2: TryFuture<Error = Self::Error>,
    Fut3: TryFuture<Error = Self::Error>,
    Fut4: TryFuture<Error = Self::Error>,
    Fut5: TryFuture<Error = Self::Error>, 
[src]

Same as try_join, but with more futures. Read more

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

fn next(&mut self) -> Next<Self> where
    Self: Unpin
[src]

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

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

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

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

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

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

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

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = Option<T>>, 
[src]

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

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future
[src]

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

fn collect<C>(self) -> Collect<Self, C> where
    C: Default + Extend<Self::Item>, 
[src]

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

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

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

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

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

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream
[src]

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

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, 
[src]

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

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, 
[src]

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

fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>, 
[src]

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

fn for_each_concurrent<Fut, F, impl Into>>(
    self,
    limit: impl Into>,
    f: F
) -> ForEachConcurrent<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>,
    impl Into>: Into<Option<usize>>, 
[src]

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

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

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

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

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

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

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used t turn any Stream into a FusedStream. Read more

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

Borrows a stream, rather than consuming it. Read more

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

Catches unwinding panics while polling the stream. Read more

fn boxed(self) -> Pin<Box<Self>>
[src]

Wrap the stream in a Box, pinning it.

fn buffered(self, n: usize) -> Buffered<Self> where
    Self::Item: Future
[src]

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

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where
    Self::Item: Future
[src]

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

fn zip<St>(self, other: St) -> Zip<Self, St> where
    St: Stream
[src]

An adapter for zipping two streams together. Read more

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

Adapter for chaining two stream. Read more

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

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

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

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

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

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

fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink + Unpin,
    Self: Stream<Item = Result<<S as Sink>::SinkItem, <S as Sink>::SinkError>>, 
[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
[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), 
[src]

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

fn left_stream<B>(self) -> Either<Self, B> where
    B: Stream<Item = Self::Item>, 
[src]

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

fn right_stream<B>(self) -> Either<B, Self> where
    B: Stream<Item = Self::Item>, 
[src]

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

fn poll_next_unpin(&mut self, lw: &LocalWaker) -> Poll<Option<Self::Item>> where
    Self: Unpin
[src]

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

fn select_next_some(&mut self) -> SelectNextSome<Self> where
    Self: Unpin + FusedStream
[src]

Returns a [Future] that resolves when the next item in this stream is ready. Read more

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

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

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

fn err_into<E>(self) -> ErrInto<Self, E> where
    Self::Error: Into<E>, 
[src]

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

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
    F: FnMut(Self::Ok) -> T, 
[src]

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

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

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

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

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

fn try_next(&mut self) -> TryNext<Self> where
    Self: Unpin
[src]

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

fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: TryFuture<Ok = (), Error = Self::Error>, 
[src]

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

fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F> where
    F: FnMut(&Self::Ok) -> Fut,
    Fut: TryFuture<Ok = bool, Error = Self::Error>, 
[src]

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

fn try_for_each_concurrent<Fut, F, impl Into>>(
    self,
    limit: impl Into>,
    f: F
) -> TryForEachConcurrent<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: Future<Output = Result<(), Self::Error>>,
    impl Into>: Into<Option<usize>>, 
[src]

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

fn try_collect<C>(self) -> TryCollect<Self, C> where
    C: Default + Extend<Self::Ok>, 
[src]

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

fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: TryFuture<Ok = Option<T>, Error = Self::Error>, 
[src]

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

fn try_fold<T, Fut, F>(self, init: T, f: F) -> TryFold<Self, Fut, T, F> where
    F: FnMut(T, Self::Ok) -> Fut,
    Fut: TryFuture<Ok = T, Error = Self::Error>, 
[src]

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

fn try_concat(self) -> TryConcat<Self> where
    Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>,
    Self::Ok: IntoIterator,
    Self::Ok: Default
[src]

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

fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self> where
    Self::Ok: TryFuture,
    <Self::Ok as TryFuture>::Error == Self::Error
[src]

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

fn try_poll_next_unpin(
    &mut self,
    lw: &LocalWaker
) -> Poll<Option<Result<Self::Ok, Self::Error>>> where
    Self: Unpin
[src]

A convenience method for calling [TryStream::poll_next_unpin] on [Unpin] stream types. Read more

Important traits for Compat<R>
fn compat(self) -> Compat<Self> where
    Self: Unpin
[src]

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}; # let (tx, rx) = futures::channel::oneshot::channel(); Read more

fn into_async_read(self) -> IntoAsyncRead<Self> where
    Self: TryStreamExt<Error = Error> + Unpin,
    Self::Ok: AsRef<[u8]>, 
[src]

Adapter that converts this stream into an [AsyncRead]. Read more

impl<R> AsyncReadExt for R where
    R: AsyncRead + ?Sized
[src]

fn copy_into<W>(&'a mut self, writer: &'a mut W) -> CopyInto<'a, Self, W> where
    W: AsyncWrite
[src]

Creates a future which copies all the bytes from one object to another. Read more

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>
[src]

Tries to read some bytes directly into the given buf in asynchronous manner, returning a future type. Read more

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>
[src]

Creates a future which will read exactly enough bytes to fill buf, returning an error if end of file (EOF) is hit sooner. Read more

fn read_to_end(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>
[src]

Creates a future which will read all the bytes from this AsyncRead. Read more

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
    Self: AsyncWrite
[src]

Helper method for splitting this read/write object into two halves. Read more

Important traits for Compat<R>
fn compat(self) -> Compat<Self>
[src]

Wraps an [AsyncRead] in a compatibility wrapper that allows it to be used as a futures 0.1 / tokio-io 0.1 AsyncRead. If the wrapped type implements [AsyncWrite] as well, the result will also implement the futures 0.1 / tokio 0.1 AsyncWrite trait. Read more

impl<W> AsyncWriteExt for W where
    W: AsyncWrite + ?Sized
[src]

fn flush(&mut self) -> Flush<Self>
[src]

Creates a future which will entirely flush this AsyncWrite. Read more

fn close(&mut self) -> Close<Self>
[src]

Creates a future which will entirely close this AsyncWrite.

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self>
[src]

Write data into this object. Read more

Important traits for Compat<R>
fn compat_write(self) -> Compat<Self>
[src]

Wraps an [AsyncWrite] in a compatibility wrapper that allows it to be used as a futures 0.1 / tokio-io 0.1 AsyncWrite. Requires the io-compat feature to enable. Read more