Struct futures_util::compat::Compat

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

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

Methods

impl<T> Compat<T>

pub fn into_inner(self) -> T

Returns the inner item.

Trait Implementations

impl<T: Debug> Debug for Compat<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<W: AsyncWrite03> Write for Compat<W>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

Important traits for &'_ mut I

impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl<R: AsyncRead03> Read for Compat<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

Important traits for &'_ mut I

impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

Important traits for Bytes<R>

impl<R> Iterator for Bytes<R> where
    R: Read,  type Item = Result<u8, Error>;

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where     R: Read,

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl<Fut> Future for Compat<Fut> where     Fut: TryFuture03 + Unpin,

type Item = Fut::Ok

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

type Error = Fut::Error

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

fn poll(&mut self) -> Poll01<Self::Item, Self::Error>

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

fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

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

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

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

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

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

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

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

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

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

Execute another future after this one has resolved successfully.

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

Execute another future if this one resolves with an error.

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

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where     B: IntoFuture,

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

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where     B: IntoFuture<Error = Self::Error>,

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

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

Same as join, but with more futures.

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

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 as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where     B: IntoFuture<Error = Self::Error>,     C: IntoFuture<Error = Self::Error>,     D: IntoFuture<Error = Self::Error>,     E: IntoFuture<Error = Self::Error>,

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

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

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

fn flatten_stream(self) -> FlattenStream<Self> where     Self::Item: Stream,     <Self::Item as Stream>::Error == Self::Error,

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

fn fuse(self) -> Fuse<Self>

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

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

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

fn catch_unwind(self) -> CatchUnwind<Self> where     Self: UnwindSafe,

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

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

impl<St> Stream for Compat<St> where     St: TryStream03 + Unpin,

type Item = St::Ok

The type of item this stream will yield on success.

type Error = St::Error

The type of error this stream may generate.

fn poll(&mut self) -> Poll01<Option<Self::Item>, Self::Error>

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

Important traits for Wait<S>

impl<S> Iterator for Wait<S> where
    S: Stream,  type Item = Result<<S as Stream>::Item, <S as Stream>::Error>;

fn wait(self) -> Wait<Self>

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

fn into_future(self) -> StreamFuture<Self>

Converts this stream into a Future.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn collect(self) -> Collect<Self>

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

fn concat2(self) -> Concat2<Self> where     Self::Item: Extend<<Self::Item as IntoIterator>::Item>,     Self::Item: IntoIterator,     Self::Item: Default,

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

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

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.

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 as IntoFuture>::Error>,

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

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

Flattens a stream of streams into just one continuous stream.

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>,

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

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>,

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

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

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

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

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

fn take(self, amt: u64) -> Take<Self>

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

fn skip(self, amt: u64) -> Skip<Self>

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

fn fuse(self) -> Fuse<Self>

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

Important traits for &'_ mut I

impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn by_ref(&mut self) -> &mut Self

Borrows a stream, rather than consuming it.

fn catch_unwind(self) -> CatchUnwind<Self> where     Self: UnwindSafe,

Catches unwinding panics while polling the stream.

fn buffered(self, amt: usize) -> Buffered<Self> where     Self::Item: IntoFuture,     <Self::Item as IntoFuture>::Error == Self::Error,

An adaptor for creating a buffered list of pending futures.

fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where     Self::Item: IntoFuture,     <Self::Item as IntoFuture>::Error == Self::Error,

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

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

Deprecated

: functionality provided by select now

An adapter for merging the output of two streams.

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

An adapter for zipping two streams together.

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

Adapter for chaining two stream.

fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method.

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

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

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

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

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

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

fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where     Self: Sink,

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

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

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

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

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

impl<Sp, Fut> Executor<Fut> for Compat<Sp> where     &'a Sp: Spawn03,     Fut: Future01<Item = (), Error = ()> + Send + 'static,

fn execute(&self, future: Fut) -> Result<(), ExecuteError01<Fut>>

Spawns a future to run on this Executor, typically in the "background".

impl<T> Sink for Compat<T> where     T: Sink03 + Unpin,

type SinkItem = T::SinkItem

The type of value that the sink accepts.

type SinkError = T::SinkError

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

fn start_send(     &mut self,     item: Self::SinkItem ) -> StartSend01<Self::SinkItem, Self::SinkError>

Begin the process of sending a value to the sink.

fn poll_complete(&mut self) -> Poll01<(), Self::SinkError>

Flush all output from this sink, if necessary.

fn close(&mut self) -> Poll01<(), Self::SinkError>

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

fn wait(self) -> Wait<Self>

Creates a new object which will produce a synchronous sink.

fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut> where     F: FnMut(U) -> Fut,     Fut: IntoFuture<Item = Self::SinkItem>,     <Fut as IntoFuture>::Error: From<Self::SinkError>,

Composes a function in front of the sink.

fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St> where     F: FnMut(U) -> St,     St: Stream<Item = Self::SinkItem, Error = Self::SinkError>,

Composes a function in front of the sink.

fn sink_map_err<F, E>(self, f: F) -> SinkMapErr<Self, F> where     F: FnOnce(Self::SinkError) -> E,

Transforms the error returned by the sink.

fn sink_from_err<E>(self) -> SinkFromErr<Self, E> where     E: From<Self::SinkError>,

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

fn buffer(self, amt: usize) -> Buffer<Self>

Adds a fixed-size buffer to the current sink.

fn fanout<S>(self, other: S) -> Fanout<Self, S> where     S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,     Self::SinkItem: Clone,

Fanout items to multiple sinks.

fn flush(self) -> Flush<Self>

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

fn send(self, item: Self::SinkItem) -> Send<Self>

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

fn send_all<S>(self, stream: S) -> SendAll<Self, S> where     S: Stream<Item = Self::SinkItem>,     Self::SinkError: From<<S as Stream>::Error>,

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

impl<R: AsyncRead03> AsyncRead for Compat<R>

unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

fn poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>, Error>

Attempt to read from the AsyncRead into buf.

fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where     B: BufMut,

Pull some bytes from this source into the specified Buf, returning how many bytes were read.

fn framed<T>(self, codec: T) -> Framed<Self, T> where     Self: AsyncWrite,     T: Decoder + Encoder,

Deprecated since 0.1.7

: Use tokio_codec::Decoder::framed instead

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

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

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

impl<W: AsyncWrite03> AsyncWrite for Compat<W>

fn shutdown(&mut self) -> Result<Async01<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write(&mut self, buf: &[u8]) -> Result<Async<usize>, Error>

Attempt to write bytes from buf into the object.

fn poll_flush(&mut self) -> Result<Async<()>, Error>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn write_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where     B: Buf,

Write a Buf into this value, returning how many bytes were written.