Crate futures_01_ext
source ·Expand description
Crate extending functionality of futures
crate
Re-exports
pub use futures as futures_reexport;
Modules
- A layered
Decoder
adapter forStream
transformations - A layered
Encoder
adapter forStream
transformations - Extends the functionality of std::io and ::tokio_io
Macros
- 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.
- 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.
- A convenience macro for working with
io::Result<T>
from theRead
andWrite
traits. - 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. - 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. - 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
- It’s a combinator that converts
Stream<A>
intoStream<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 - Params for StreamExt::buffered_weight_limited and WeightLimitedBufferedStream
- A future that yields a single decoded item from the Bytes of the provided BytesStream (if any) and the remaining BytesStream.
- A future which collects all of the values of a stream into a vector.
- Stream returned as a result of calling crate::StreamExt::collect_to
- 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
- Map
Item
andError
to()
- Like std::iter::Enumerate, but for Stream
- A future which takes a list of futures, executes them serially, and resolves with a vector of the completed values.
- Do something with an error if the future failed.
- Inspect the Result returned by a future
- A stream wrapper returned by StreamExt::return_remainder
- An unbounded set of streams
- Simple adapter from
Sink
interface toAsyncWrite
interface. It can be useful to convert from the interface that supports only AsyncWrite, and get Stream as a result. - Like stream::Buffered, but can also limit number of futures in a buffer by “weight”.
Enums
- Error that can be returned by ConservativeReceiver
- Like future::Either, but for Stream
Traits
- A trait implemented by default for all Futures which extends the standard functionality.
- A trait implemented by default for all Streams which extends the standard functionality.
- Trait that provides a function for making a decoding layer on top of Stream of Bytes
Functions
- Creates a stream which returns results of the futures given.
- Convert a list of streams into a
Stream
of results from the streams. - 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.
- 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
- Replacement for BoxFuture, deprecated in upstream futures-rs.
- Replacement for BoxFutureNonSend, deprecated in upstream futures-rs.
- Replacement for BoxStream, deprecated in upstream futures-rs.
- Replacement for BoxStreamNonSend, deprecated in upstream futures-rs.