# Module futures_util::stream [−] [src]

Asynchronous streams.

This module contains:

- The `Stream` trait, for objects that can asynchronously produce a sequence of values.
- The `StreamExt` and `TryStreamExt` trait, which provides adapters for chaining and composing streams.
- Top-level stream constructors like `iter` which creates a stream from an iterator.

## Structs

AndThen | Stream for the `and_then` method.
Chain | Stream for the `chain` method.
Collect | Future for the `collect` method.
Concat | Future for the `concat` 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.
Flatten | Stream for the `flatten` method.
Fold | Future for the `fold` method.
ForEach | Future for the `for_each` method.
Fuse | Stream for the `fuse` method.
Inspect | Stream for the `inspect` method.
InspectErr | Stream for the `inspect_err` method.
InspectOk | Stream for the `inspect_ok` 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.
Once | A stream which emits single element and then EOF.
OrElse | Stream for the `or_else` method.
Peek | Future for the `Peekable::peek()` function from `Peekable`
Peekable | A `Stream` that implements a `peek` method.
Pending | Stream for the `pending()` function.
PollFn | Stream for the `poll_fn` function.
Repeat | Stream for the `repeat` function.
RepeatWith | An stream that repeats elements of type `A` endlessly by applying the provided closure `F: FnMut() -> A`.
Scan | Stream for the `scan` method.
Select | Stream for the `select()` function.
SelectNextSome | Future for the `select_next_some` method.
Skip | Stream for the `skip` method.
SkipWhile | Stream for the `skip_while` method.
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.
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.
TryFold | Future for the `try_fold` method.
TryForEach | Future for the `try_for_each` method.
TryNext | Future for the `try_next` method.
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.

## Traits

FusedStream | A stream which tracks whether or not the underlying stream should no longer be polled.
Stream | A stream of values produced asynchronously.
StreamExt | An extension trait for `Stream`s that provides a variety of convenient combinator functions.
TryStream | A convenience for streams that return `Result` values that includes a variety of adapters tailored to such futures.
TryStreamExt | Adapters specific to `Result`-returning streams

## Functions

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>>`.
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.
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`.