Crate futures_01_ext

Crate extending functionality of futures crate

Re-exports

• pub use futures as futures_reexport;

Modules

• decode
  A layered Decoder adapter for Stream transformations
• encode
  A layered Encoder adapter for Stream transformations
• io
  Extends the functionality of std::io and ::tokio_io

Macros

• ensure_boxfuture
  Macro that can be used like ensure! macro from failure crate, but in the context where the expected return type is BoxFuture. Exits a function early with an Error if the condition is not satisfied.
• ensure_boxstream
  Macro that can be used like ensure! macro from failure crate, but in the context where the expected return type is BoxStream. Exits a function early with an Error if the condition is not satisfied.
• handle_nb
  A convenience macro for working with io::Result<T> from the Read and Write traits.
• try_boxfuture
  Macro that can be used like ? operator, but in the context where the expected return type is BoxFuture. The result of it is either Ok part of Result or immediate returning the Err part converted into BoxFuture.
• try_boxstream
  Macro that can be used like ? operator, but in the context where the expected return type is BoxStream. The result of it is either Ok part of Result or immediate returning the Err part converted into BoxStream.
• try_left_future
  Macro that can be used like ? operator, but in the context where the expected return type is a left future. The result of it is either Ok part of Result or immediate returning the Err

Structs

• BatchStream
  It’s a combinator that converts Stream<A> into Stream<Vec<A>>. So interface is similar to .chunks() method, but there’s an important difference: BatchStream won’t wait until the whole batch fills up i.e. as soon as underlying stream return NotReady, then new batch is returned from BatchStream
• BufferedParams
  Params for StreamExt::buffered_weight_limited and WeightLimitedBufferedStream
• BytesStream
  A structure that wraps a Stream of Bytes and lets it being accessed both as a Stream and as AsyncRead. It is very useful when decoding Stream of Bytes in an asynchronous way.
• BytesStreamFuture
  A future that yields a single decoded item from the Bytes of the provided BytesStream (if any) and the remaining BytesStream.
• CollectNoConsume
  A future which collects all of the values of a stream into a vector.
• CollectTo
  Stream returned as a result of calling crate::StreamExt::collect_to
• ConservativeReceiver
  This is a wrapper around oneshot::Receiver that will return error when the receiver was polled and the result was not ready. This is a very strict way of preventing deadlocks in code when receiver is polled before the sender has send the result
• Discard
  Map Item and Error to ()
• Enumerate
  Like std::iter::Enumerate, but for Stream
• FuturesOrdered
  A future which takes a list of futures, executes them serially, and resolves with a vector of the completed values.
• InspectErr
  Do something with an error if the future failed.
• InspectResult
  Inspect the Result returned by a future
• ReturnRemainder
  A stream wrapper returned by StreamExt::return_remainder
• SelectAll
  An unbounded set of streams
• SinkToAsyncWrite
  Simple adapter from Sink interface to AsyncWrite interface. It can be useful to convert from the interface that supports only AsyncWrite, and get Stream as a result.
• WeightLimitedBufferedStream
  Like stream::Buffered, but can also limit number of futures in a buffer by “weight”.

Enums

• ConservativeReceiverError
  Error that can be returned by ConservativeReceiver
• StreamEither
  Like future::Either, but for Stream

Traits

• FutureExt
  A trait implemented by default for all Futures which extends the standard functionality.
• StreamExt
  A trait implemented by default for all Streams which extends the standard functionality.
• StreamLayeredExt
  Trait that provides a function for making a decoding layer on top of Stream of Bytes

Functions

• futures_ordered
  Creates a stream which returns results of the futures given.
• select_all
  Convert a list of streams into a Stream of results from the streams.
• send_discard
  Send an item over an mpsc channel, discarding both the sender and receiver-closed errors. This should be used when the receiver being closed makes sending values moot, since no one is interested in the results any more.
• split_err
  Given an input stream, split its error out to a separate Future, and returning that error Future and an infallable Stream. There are two outcomes:

Type Aliases

• BoxFuture
  Replacement for BoxFuture, deprecated in upstream futures-rs.
• BoxFutureNonSend
  Replacement for BoxFutureNonSend, deprecated in upstream futures-rs.
• BoxStream
  Replacement for BoxStream, deprecated in upstream futures-rs.
• BoxStreamNonSend
  Replacement for BoxStreamNonSend, deprecated in upstream futures-rs.