# Struct futures::stream::Wait [−] [src]

    #[must_use = "iterators do nothing unless advanced"]
    pub struct Wait<S> { /* fields omitted */ }

A stream combinator which converts an asynchronous stream to a blocking iterator.

Created by the `Stream::wait` method, this function transforms any stream into a standard iterator. This is implemented by blocking the current thread while items on the underlying stream aren't ready yet.

## Methods

### `impl<S> Wait<S>`
[src]

#### `pub fn get_ref(&self) -> &S`
[src]

Acquires a reference to the underlying stream that this combinator is pulling from.

#### `pub fn get_mut(&mut self) -> &mut S`
[src]

Acquires a mutable reference to the underlying stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the stream which may otherwise confuse this combinator.

#### `pub fn into_inner(self) -> S`
[src]

Consumes this combinator, returning the underlying stream.

Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.

## Trait Implementations

### `impl<S: Debug> Debug for Wait<S>`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl<S: Stream> Iterator for Wait<S>`
[src]

#### `type Item = Result<S::Item, S::Error>`

The type of the elements being iterated over.

#### `fn next(&mut self) -> Option<Self::Item>`
[src]

Advances the iterator and returns the next value. Read more

#### `fn size_hint(&self) -> (usize, Option<usize>)`
1.0.0
[src]

Returns the bounds on the remaining length of the iterator. Read more

#### `fn count(self) -> usize`
1.0.0
[src]

Consumes the iterator, counting the number of iterations and returning it. Read more

#### `fn last(self) -> Option<Self::Item>`
1.0.0
[src]

Consumes the iterator, returning the last element. Read more

#### `fn nth(&mut self, n: usize) -> Option<Self::Item>`
1.0.0
[src]

Returns the `n`th element of the iterator. Read more

#### `fn step_by(self, step: usize) -> StepBy<Self>`
[src]

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

unstable replacement of Range::step_by

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more

#### `fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,`
1.0.0
[src]

Takes two iterators and creates a new iterator over both in sequence. Read more

#### `fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,`
1.0.0
[src]

'Zips up' two iterators into a single iterator of pairs. Read more

#### `fn map<B, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> B,`
1.0.0
[src]

Takes a closure and creates an iterator which calls that closure on each element. Read more

#### `fn for_each<F>(self, f: F) where
F: FnMut(Self::Item),`
1.21.0
[src]

Calls a closure on each element of an iterator. Read more

#### `fn filter<P>(self, predicate: P) -> Filter<Self, P> where
P: FnMut(&Self::Item) -> bool,`
1.0.0
[src]

Creates an iterator which uses a closure to determine if an element should be yielded. Read more

#### `fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,`
1.0.0
[src]

Creates an iterator that both filters and maps. Read more

#### `fn enumerate(self) -> Enumerate<Self>`
1.0.0
[src]

Creates an iterator which gives the current iteration count as well as the next value. Read more

#### `fn peekable(self) -> Peekable<Self>`
1.0.0
[src]

Creates an iterator which can use `peek` to look at the next element of the iterator without consuming it. Read more

#### `fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,`
1.0.0
[src]

Creates an iterator that [`skip`]s elements based on a predicate. Read more

#### `fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,`
1.0.0
[src]

Creates an iterator that yields elements based on a predicate. Read more

#### `fn skip(self, n: usize) -> Skip<Self>`
1.0.0
[src]

Creates an iterator that skips the first `n` elements. Read more

#### `fn take(self, n: usize) -> Take<Self>`
1.0.0
[src]

Creates an iterator that yields its first `n` elements. Read more

#### `fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
F: FnMut(&mut St, Self::Item) -> Option<B>,`
1.0.0
[src]

An iterator adaptor similar to [`fold`] that holds internal state and produces a new iterator. Read more

#### `fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoIterator,`
1.0.0
[src]

Creates an iterator that works like map, but flattens nested structure. Read more

#### `fn fuse(self) -> Fuse<Self>`
1.0.0
[src]

Creates an iterator which ends after the first [`None`]. Read more

#### `fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),`
1.0.0
[src]

Do something with each element of an iterator, passing the value on. Read more

#### `fn by_ref(&mut self) -> &mut Self`
1.0.0
[src]

Borrows an iterator, rather than consuming it. Read more

#### `fn collect<B>(self) -> B where
B: FromIterator<Self::Item>,`
1.0.0
[src]

Transforms an iterator into a collection. Read more

#### `fn partition<B, F>(self, f: F) -> (B, B) where
B: Default + Extend<Self::Item>,
F: FnMut(&Self::Item) -> bool,`
1.0.0
[src]

Consumes an iterator, creating two collections from it. Read more

#### `fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,`
[src]

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

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more

#### `fn fold<B, F>(self, init: B, f: F) -> B where
F: FnMut(B, Self::Item) -> B,`
1.0.0
[src]

An iterator method that applies a function, producing a single, final value. Read more

#### `fn all<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,`
1.0.0
[src]

Tests if every element of the iterator matches a predicate. Read more

#### `fn any<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,`
1.0.0
[src]

Tests if any element of the iterator matches a predicate. Read more

#### `fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,`
1.0.0
[src]

Searches for an element of an iterator that satisfies a predicate. Read more

#### `fn position<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,`
1.0.0
[src]

Searches for an element in an iterator, returning its index. Read more

#### `fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,`
1.0.0
[src]

Searches for an element in an iterator from the right, returning its index. Read more

#### `fn max(self) -> Option<Self::Item> where
Self::Item: Ord,`
1.0.0
[src]

Returns the maximum element of an iterator. Read more

#### `fn min(self) -> Option<Self::Item> where
Self::Item: Ord,`
1.0.0
[src]

Returns the minimum element of an iterator. Read more

#### `fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,`
1.6.0
[src]

Returns the element that gives the maximum value from the specified function. Read more

#### `fn max_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,`
1.15.0
[src]

Returns the element that gives the maximum value with respect to the specified comparison function. Read more

#### `fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,`
1.6.0
[src]

Returns the element that gives the minimum value from the specified function. Read more

#### `fn min_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,`
1.15.0
[src]

Returns the element that gives the minimum value with respect to the specified comparison function. Read more

#### `fn rev(self) -> Rev<Self> where
Self: DoubleEndedIterator,`
1.0.0
[src]

Reverses an iterator's direction. Read more

#### `fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Iterator<Item = (A, B)>,`
1.0.0
[src]

Converts an iterator of pairs into a pair of containers. Read more

#### `fn cloned<'a, T>(self) -> Cloned<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Clone,`
1.0.0
[src]

Creates an iterator which [`clone`]s all of its elements. Read more

#### `fn cycle(self) -> Cycle<Self> where
Self: Clone,`
1.0.0
[src]

Repeats an iterator endlessly. Read more

#### `fn sum<S>(self) -> S where
S: Sum<Self::Item>,`
1.11.0
[src]

Sums the elements of an iterator. Read more

#### `fn product<P>(self) -> P where
P: Product<Self::Item>,`
1.11.0
[src]

Iterates over the entire iterator, multiplying all the elements Read more

#### `fn cmp<I>(self, other: I) -> Ordering where
I: IntoIterator<Item = Self::Item>,
Self::Item: Ord,`
1.5.0
[src]

Lexicographically compares the elements of this `Iterator` with those of another. Read more

#### `fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Lexicographically compares the elements of this `Iterator` with those of another. Read more

#### `fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are equal to those of another. Read more

#### `fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are unequal to those of another. Read more

#### `fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are lexicographically less than those of another. Read more

#### `fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are lexicographically less or equal to those of another. Read more

#### `fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are lexicographically greater than those of another. Read more

#### `fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are lexicographically greater than or equal to those of another. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)