stream - futures

Modules

futures_unordered An unbounded set of futures.
select_all An unbounded set of streams

Structs

AbortHandle A handle to an Abortable task.
AbortRegistration A registration handle for an Abortable task. Values of this type can be acquired from AbortHandle::new and are used in calls to Abortable::new.
Abortable A future/stream which can be remotely short-circuited using an AbortHandle.
Aborted Indicator that the Abortable task was aborted.
All Future for the all method.
AndThen Stream for the and_then method.
Any Future for the any method.
BufferUnordered Stream for the buffer_unordered method.
Buffered Stream for the buffered method.
CatchUnwind Stream for the catch_unwind method.
Chain Stream for the chain method.
Chunks Stream for the chunks method.
Collect Future for the collect method.
Concat Future for the concat method.
Count Future for the count method.
Cycle Stream for the cycle method.
Empty Stream for the empty function.
Enumerate Stream for the enumerate method.
ErrInto Stream for the err_into method.
Filter Stream for the filter method.
FilterMap Stream for the filter_map method.
FlatMap Stream for the flat_map method.
FlatMapUnordered Stream for the flat_map_unordered method.
Flatten Stream for the flatten method.
Fold Future for the fold method.
ForEach Future for the for_each method.
ForEachConcurrent Future for the for_each_concurrent method.
Forward Future for the forward method.
Fuse Stream for the fuse method.
FuturesOrdered An unbounded queue of futures.
FuturesUnordered A set of futures which may complete in any order.
Inspect Stream for the inspect method.
InspectErr Stream for the inspect_err method.
InspectOk Stream for the inspect_ok method.
IntoAsyncRead Reader for the into_async_read method.
IntoStream Stream for the into_stream method.
Iter Stream for the iter function.
Map Stream for the map method.
MapErr Stream for the map_err method.
MapOk Stream for the map_ok method.
Next Future for the next method.
NextIf Future for the Peekable::next_if method.
NextIfEq Future for the Peekable::next_if_eq method.
Once A stream which emits single element and then EOF.
OrElse Stream for the or_else method.
Peek Future for the Peekable::peek method.
PeekMut Future for the Peekable::peek_mut method.
Peekable A Stream that implements a peek method.
Pending Stream for the [pending()] function.
PollFn Stream for the poll_fn function.
PollImmediate Stream for the poll_immediate function.
ReadyChunks Stream for the ready_chunks method.
Repeat Stream for the repeat function.
RepeatWith An stream that repeats elements of type A endlessly by applying the provided closure F: FnMut() -> A.
ReuniteError Error indicating a SplitSink<S> and SplitStream<S> were not two halves of a Stream + Split, and thus could not be reunited.
Scan Stream for the scan method.
Select Stream for the [select()] function.
SelectAll An unbounded set of streams
SelectNextSome Future for the select_next_some method.
SelectWithStrategy Stream for the [select_with_strategy()] function. See function docs for details.
Skip Stream for the skip method.
SkipWhile Stream for the skip_while method.
SplitSink A Sink part of the split pair
SplitStream A Stream part of the split pair
StreamFuture Future for the into_future method.
Take Stream for the take method.
TakeUntil Stream for the take_until method.
TakeWhile Stream for the take_while method.
Then Stream for the then method.
TryAll Future for the try_all method.
TryAny Future for the try_any method.
TryBufferUnordered Stream for the try_buffer_unordered method.
TryBuffered Stream for the try_buffered method.
TryChunks Stream for the try_chunks method.
TryChunksError Error indicating, that while chunk was collected inner stream produced an error.
TryCollect Future for the try_collect method.
TryConcat Future for the try_concat method.
TryFilter Stream for the try_filter method.
TryFilterMap Stream for the try_filter_map method.
TryFlatten Stream for the try_flatten method.
TryFlattenUnordered Stream for the try_flatten_unordered method.
TryFold Future for the try_fold method.
TryForEach Future for the try_for_each method.
TryForEachConcurrent Future for the try_for_each_concurrent method.
TryNext Future for the try_next method.
TryReadyChunks Stream for the try_ready_chunks method.
TryReadyChunksError Error indicating, that while chunk was collected inner stream produced an error.
TrySkipWhile Stream for the try_skip_while method.
TryTakeWhile Stream for the try_take_while method.
TryUnfold Stream for the try_unfold function.
Unfold Stream for the unfold function.
Unzip Future for the unzip method.
Zip Stream for the zip method.

Enums

PollNext Type to tell SelectWithStrategy which stream to poll next.

Traits

FusedStream
Stream
StreamExt An extension trait for Streams that provides a variety of convenient combinator functions.
TryStream
TryStreamExt Adapters specific to Result-returning streams

Functions

abortable Creates a new Abortable stream and an AbortHandle which can be used to stop it.
empty Creates a stream which contains no elements.
iter Converts an Iterator into a Stream which is always ready to yield the next value.
once Creates a stream of a single element.
pending Creates a stream which never returns any elements.
poll_fn Creates a new stream wrapping a function returning Poll<Option<T>>.
poll_immediate Creates a new stream that always immediately returns Poll::Ready when awaiting it.
repeat Create a stream which produces the same item repeatedly.
repeat_with Creates a new stream that repeats elements of type A endlessly by applying the provided closure, the repeater, F: FnMut() -> A.
select This function 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.
select_all Convert a list of streams into a Stream of results from the streams.
select_with_strategy This function will attempt to pull items from both streams. You provide a closure to tell SelectWithStrategy which stream to poll. The closure can store state on SelectWithStrategy to which it will receive a &mut on every invocation. This allows basing the strategy on prior choices.
try_unfold Creates a TryStream from a seed and a closure returning a TryFuture.
unfold Creates a Stream from a seed and a closure returning a Future.

Type Aliases

BoxStream
FlattenUnordered Stream for the flatten_unordered method.
LocalBoxStream