std::iter::Fuse - Rust
Description: API documentation for the Rust `Fuse` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, Fuse

# 1.0.0[−][src]Struct std::iter::Fuse

    #[must_use = "iterators are lazy and do nothing unless consumed"]
    pub struct Fuse<I> { /* fields omitted */ }

An iterator that yields `None` forever after the underlying iterator yields `None` once.

This `struct` is created by the `fuse` method on `Iterator`. See its documentation for more.

## Trait Implementations

### `impl<I> DoubleEndedIterator for Fuse<I> where
I: DoubleEndedIterator + FusedIterator,` 1.26.0[src]

#### `fn next_back(&mut self) -> Option<<I as Iterator>::Item>`[src]

Removes and returns an element from the end of the iterator. Read more

#### `fn nth_back(&mut self, n: usize) -> Option<<I as Iterator>::Item>`[src]

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

#### `fn try_rfold<Acc, Fold, R>(&mut self, init: Acc, fold: Fold) -> R where
Fold: FnMut(Acc, <Fuse<I> as Iterator>::Item) -> R,
R: Try<Ok = Acc>,
Fuse<I>: Sized,` [src]

This is the reverse version of [`try_fold()`]: it takes elements starting from the back of the iterator. Read more

#### `fn rfold<Acc, Fold>(self, init: Acc, fold: Fold) -> Acc where
Fold: FnMut(Acc, <Fuse<I> as Iterator>::Item) -> Acc,` [src]

An iterator method that reduces the iterator's elements to a single, final value, starting from the back. Read more

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

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

### `impl<I> DoubleEndedIterator for Fuse<I> where
I: DoubleEndedIterator,` [src]

#### `default fn next_back(&mut self) -> Option<<I as Iterator>::Item>`[src]

Removes and returns an element from the end of the iterator. Read more

#### `default fn nth_back(&mut self, n: usize) -> Option<<I as Iterator>::Item>`[src]

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

#### `default fn try_rfold<Acc, Fold, R>(&mut self, init: Acc, fold: Fold) -> R where
Fold: FnMut(Acc, <Fuse<I> as Iterator>::Item) -> R,
R: Try<Ok = Acc>,
Fuse<I>: Sized,` [src]

This is the reverse version of [`try_fold()`]: it takes elements starting from the back of the iterator. Read more

#### `default fn rfold<Acc, Fold>(self, init: Acc, fold: Fold) -> Acc where
Fold: FnMut(Acc, <Fuse<I> as Iterator>::Item) -> Acc,` [src]

An iterator method that reduces the iterator's elements to a single, final value, starting from the back. Read more

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

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

### `impl<I> FusedIterator for Fuse<I> where
I: Iterator,` 1.26.0[src]

### `impl<I> Iterator for Fuse<I> where
I: FusedIterator,` 1.26.0[src]

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

Advances the iterator and returns the next value. Read more

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

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

#### `fn last(self) -> Option<<I as Iterator>::Item>`[src]

Consumes the iterator, returning the last element. Read more

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

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

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

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

#### `fn try_fold<Acc, Fold, R>(&mut self, init: Acc, fold: Fold) -> R where
Fold: FnMut(Acc, <Fuse<I> as Iterator>::Item) -> R,
R: Try<Ok = Acc>,
Fuse<I>: Sized,` [src]

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

#### `fn fold<Acc, Fold>(self, init: Acc, fold: Fold) -> Acc where
Fold: FnMut(Acc, <Fuse<I> as Iterator>::Item) -> Acc,` [src]

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

#### `type Item`

The type of the elements being iterated over.

####
ⓘImportant traits for StepBy<I>

### Important traits for StepBy<I>

`impl<I> Iterator for StepBy<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn step_by(self, step: usize) -> StepBy<Self>`1.28.0[src]

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

####
ⓘImportant traits for Chain<A, B>

### Important traits for Chain<A, B>

`impl<A, B> Iterator for Chain<A, B> where
A: Iterator,
B: Iterator<Item = <A as Iterator>::Item>, type Item = <A as Iterator>::Item;`
`fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,` [src]

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

####
ⓘImportant traits for Zip<A, B>

### Important traits for Zip<A, B>

`impl<A, B> Iterator for Zip<A, B> where
A: Iterator,
B: Iterator, type Item = (<A as Iterator>::Item, <B as Iterator>::Item);`
`fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,` [src]

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

####
ⓘImportant traits for Map<I, F>

### Important traits for Map<I, F>

`impl<B, I, F> Iterator for Map<I, F> where
F: FnMut(<I as Iterator>::Item) -> B,
I: Iterator, type Item = B;`
`fn map<B, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> B,` [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

####
ⓘImportant traits for Filter<I, P>

### Important traits for Filter<I, P>

`impl<I, P> Iterator for Filter<I, P> where
I: Iterator,
P: FnMut(&<I as Iterator>::Item) -> bool, type Item = <I as Iterator>::Item;`
`fn filter<P>(self, predicate: P) -> Filter<Self, P> where
P: FnMut(&Self::Item) -> bool,` [src]

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

####
ⓘImportant traits for FilterMap<I, F>

### Important traits for FilterMap<I, F>

`impl<B, I, F> Iterator for FilterMap<I, F> where
F: FnMut(<I as Iterator>::Item) -> Option<B>,
I: Iterator, type Item = B;`
`fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,` [src]

Creates an iterator that both filters and maps. Read more

####
ⓘImportant traits for Enumerate<I>

### Important traits for Enumerate<I>

`impl<I> Iterator for Enumerate<I> where
I: Iterator, type Item = (usize, <I as Iterator>::Item);`
`fn enumerate(self) -> Enumerate<Self>`[src]

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

####
ⓘImportant traits for Peekable<I>

### Important traits for Peekable<I>

`impl<I> Iterator for Peekable<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn peekable(self) -> Peekable<Self>`[src]

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

####
ⓘImportant traits for SkipWhile<I, P>

### Important traits for SkipWhile<I, P>

`impl<I, P> Iterator for SkipWhile<I, P> where
I: Iterator,
P: FnMut(&<I as Iterator>::Item) -> bool, type Item = <I as Iterator>::Item;`
`fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,` [src]

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

####
ⓘImportant traits for TakeWhile<I, P>

### Important traits for TakeWhile<I, P>

`impl<I, P> Iterator for TakeWhile<I, P> where
I: Iterator,
P: FnMut(&<I as Iterator>::Item) -> bool, type Item = <I as Iterator>::Item;`
`fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,` [src]

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

####
ⓘImportant traits for Skip<I>

### Important traits for Skip<I>

`impl<I> Iterator for Skip<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn skip(self, n: usize) -> Skip<Self>`[src]

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

####
ⓘImportant traits for Take<I>

### Important traits for Take<I>

`impl<I> Iterator for Take<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn take(self, n: usize) -> Take<Self>`[src]

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

####
ⓘImportant traits for Scan<I, St, F>

### Important traits for Scan<I, St, F>

`impl<B, I, St, F> Iterator for Scan<I, St, F> where
F: FnMut(&mut St, <I as Iterator>::Item) -> Option<B>,
I: Iterator, type Item = B;`
`fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
F: FnMut(&mut St, Self::Item) -> Option<B>,` [src]

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

####
ⓘImportant traits for FlatMap<I, U, F>

### Important traits for FlatMap<I, U, F>

`impl<I, U, F> Iterator for FlatMap<I, U, F> where
F: FnMut(<I as Iterator>::Item) -> U,
I: Iterator,
U: IntoIterator, type Item = <U as IntoIterator>::Item;`
`fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoIterator,` [src]

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

####
ⓘImportant traits for Flatten<I>

### Important traits for Flatten<I>

`impl<I, U> Iterator for Flatten<I> where
I: Iterator,
U: Iterator,
<I as Iterator>::Item: IntoIterator,
<<I as Iterator>::Item as IntoIterator>::IntoIter == U,
<<I as Iterator>::Item as IntoIterator>::Item == <U as Iterator>::Item, type Item = <U as Iterator>::Item;`
`fn flatten(self) -> Flatten<Self> where
Self::Item: IntoIterator,` 1.29.0[src]

Creates an iterator that flattens nested structure. Read more

####
ⓘImportant traits for Fuse<I>

### Important traits for Fuse<I>

`impl<I> Iterator for Fuse<I> where
I: FusedIterator, impl<I> Iterator for Fuse<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn fuse(self) -> Fuse<Self>`[src]

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

####
ⓘImportant traits for Inspect<I, F>

### Important traits for Inspect<I, F>

`impl<I, F> Iterator for Inspect<I, F> where
F: FnMut(&<I as Iterator>::Item),
I: Iterator, type Item = <I as Iterator>::Item;`
`fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),` [src]

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

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn by_ref(&mut self) -> &mut Self`[src]

Borrows an iterator, rather than consuming it. Read more

#### `#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"] fn collect<B>(self) -> B where
B: FromIterator<Self::Item>,` [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,` [src]

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

#### `fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
P: FnMut(&T) -> bool,
Self: DoubleEndedIterator<Item = &'a mut T>,
T: 'a,` [src]

🔬 This is a nightly-only experimental API. (`iter_partition_in_place` #62543)

new API

Reorder the elements of this iterator in-place according to the given predicate, such that all those that return `true` precede all those that return `false`. Returns the number of `true` elements found. Read more

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

🔬 This is a nightly-only experimental API. (`iter_is_partitioned` #62544)

new API

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return `true` precede all those that return `false`. Read more

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

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more

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

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

#### `fn find_map<B, F>(&mut self, f: F) -> Option<B> where
F: FnMut(Self::Item) -> Option<B>,` 1.30.0[src]

Applies function to the elements of iterator and returns the first non-none result. Read more

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

Returns the maximum element of an iterator. Read more

#### `fn min(self) -> Option<Self::Item> where
Self::Item: Ord,` [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

####
ⓘImportant traits for Rev<I>

### Important traits for Rev<I>

`impl<I> Iterator for Rev<I> where
I: DoubleEndedIterator, type Item = <I as Iterator>::Item;`
`fn rev(self) -> Rev<Self> where
Self: DoubleEndedIterator,` [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)>,` [src]

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

####
ⓘImportant traits for Copied<I>

### Important traits for Copied<I>

`impl<'a, I, T> Iterator for Copied<I> where
I: Iterator<Item = &'a T>,
T: 'a + Copy, type Item = T;`
`fn copied<'a, T>(self) -> Copied<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Copy,` 1.36.0[src]

Creates an iterator which copies all of its elements. Read more

####
ⓘImportant traits for Cloned<I>

### Important traits for Cloned<I>

`impl<'a, I, T> Iterator for Cloned<I> where
I: Iterator<Item = &'a T>,
T: 'a + Clone, type Item = T;`
`fn cloned<'a, T>(self) -> Cloned<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Clone,` [src]

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

####
ⓘImportant traits for Cycle<I>

### Important traits for Cycle<I>

`impl<I> Iterator for Cycle<I> where
I: Clone + Iterator, type Item = <I as Iterator>::Item;`
`fn cycle(self) -> Cycle<Self> where
Self: Clone,` [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 cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
I: IntoIterator,` [src]

🔬 This is a nightly-only experimental API. (`iter_order_by` #64295)

Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. 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 partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
I: IntoIterator,` [src]

🔬 This is a nightly-only experimental API. (`iter_order_by` #64295)

Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. 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 eq_by<I, F>(self, other: I, eq: F) -> bool where
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
I: IntoIterator,` [src]

🔬 This is a nightly-only experimental API. (`iter_order_by` #64295)

Determines if the elements of this `Iterator` are equal to those of another with respect to the specified equality function. 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

#### `fn is_sorted(self) -> bool where
Self::Item: PartialOrd<Self::Item>,` [src]

🔬 This is a nightly-only experimental API. (`is_sorted` #53485)

new API

Checks if the elements of this iterator are sorted. Read more

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

🔬 This is a nightly-only experimental API. (`is_sorted` #53485)

new API

Checks if the elements of this iterator are sorted using the given comparator function. Read more

#### `fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,` [src]

🔬 This is a nightly-only experimental API. (`is_sorted` #53485)

new API

Checks if the elements of this iterator are sorted using the given key extraction function. Read more

### `impl<I> Iterator for Fuse<I> where
I: Iterator,` [src]

#### `type Item = <I as Iterator>::Item`

The type of the elements being iterated over.

#### `default fn next(&mut self) -> Option<<I as Iterator>::Item>`[src]

Advances the iterator and returns the next value. Read more

#### `default fn nth(&mut self, n: usize) -> Option<<I as Iterator>::Item>`[src]

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

#### `default fn last(self) -> Option<<I as Iterator>::Item>`[src]

Consumes the iterator, returning the last element. Read more

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

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

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

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

#### `default fn try_fold<Acc, Fold, R>(&mut self, init: Acc, fold: Fold) -> R where
Fold: FnMut(Acc, <Fuse<I> as Iterator>::Item) -> R,
R: Try<Ok = Acc>,
Fuse<I>: Sized,` [src]

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

#### `default fn fold<Acc, Fold>(self, init: Acc, fold: Fold) -> Acc where
Fold: FnMut(Acc, <Fuse<I> as Iterator>::Item) -> Acc,` [src]

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

####
ⓘImportant traits for StepBy<I>

### Important traits for StepBy<I>

`impl<I> Iterator for StepBy<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn step_by(self, step: usize) -> StepBy<Self>`1.28.0[src]

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

####
ⓘImportant traits for Chain<A, B>

### Important traits for Chain<A, B>

`impl<A, B> Iterator for Chain<A, B> where
A: Iterator,
B: Iterator<Item = <A as Iterator>::Item>, type Item = <A as Iterator>::Item;`
`fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,` [src]

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

####
ⓘImportant traits for Zip<A, B>

### Important traits for Zip<A, B>

`impl<A, B> Iterator for Zip<A, B> where
A: Iterator,
B: Iterator, type Item = (<A as Iterator>::Item, <B as Iterator>::Item);`
`fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,` [src]

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

####
ⓘImportant traits for Map<I, F>

### Important traits for Map<I, F>

`impl<B, I, F> Iterator for Map<I, F> where
F: FnMut(<I as Iterator>::Item) -> B,
I: Iterator, type Item = B;`
`fn map<B, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> B,` [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

####
ⓘImportant traits for Filter<I, P>

### Important traits for Filter<I, P>

`impl<I, P> Iterator for Filter<I, P> where
I: Iterator,
P: FnMut(&<I as Iterator>::Item) -> bool, type Item = <I as Iterator>::Item;`
`fn filter<P>(self, predicate: P) -> Filter<Self, P> where
P: FnMut(&Self::Item) -> bool,` [src]

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

####
ⓘImportant traits for FilterMap<I, F>

### Important traits for FilterMap<I, F>

`impl<B, I, F> Iterator for FilterMap<I, F> where
F: FnMut(<I as Iterator>::Item) -> Option<B>,
I: Iterator, type Item = B;`
`fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,` [src]

Creates an iterator that both filters and maps. Read more

####
ⓘImportant traits for Enumerate<I>

### Important traits for Enumerate<I>

`impl<I> Iterator for Enumerate<I> where
I: Iterator, type Item = (usize, <I as Iterator>::Item);`
`fn enumerate(self) -> Enumerate<Self>`[src]

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

####
ⓘImportant traits for Peekable<I>

### Important traits for Peekable<I>

`impl<I> Iterator for Peekable<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn peekable(self) -> Peekable<Self>`[src]

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

####
ⓘImportant traits for SkipWhile<I, P>

### Important traits for SkipWhile<I, P>

`impl<I, P> Iterator for SkipWhile<I, P> where
I: Iterator,
P: FnMut(&<I as Iterator>::Item) -> bool, type Item = <I as Iterator>::Item;`
`fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,` [src]

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

####
ⓘImportant traits for TakeWhile<I, P>

### Important traits for TakeWhile<I, P>

`impl<I, P> Iterator for TakeWhile<I, P> where
I: Iterator,
P: FnMut(&<I as Iterator>::Item) -> bool, type Item = <I as Iterator>::Item;`
`fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,` [src]

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

####
ⓘImportant traits for Skip<I>

### Important traits for Skip<I>

`impl<I> Iterator for Skip<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn skip(self, n: usize) -> Skip<Self>`[src]

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

####
ⓘImportant traits for Take<I>

### Important traits for Take<I>

`impl<I> Iterator for Take<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn take(self, n: usize) -> Take<Self>`[src]

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

####
ⓘImportant traits for Scan<I, St, F>

### Important traits for Scan<I, St, F>

`impl<B, I, St, F> Iterator for Scan<I, St, F> where
F: FnMut(&mut St, <I as Iterator>::Item) -> Option<B>,
I: Iterator, type Item = B;`
`fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
F: FnMut(&mut St, Self::Item) -> Option<B>,` [src]

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

####
ⓘImportant traits for FlatMap<I, U, F>

### Important traits for FlatMap<I, U, F>

`impl<I, U, F> Iterator for FlatMap<I, U, F> where
F: FnMut(<I as Iterator>::Item) -> U,
I: Iterator,
U: IntoIterator, type Item = <U as IntoIterator>::Item;`
`fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoIterator,` [src]

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

####
ⓘImportant traits for Flatten<I>

### Important traits for Flatten<I>

`impl<I, U> Iterator for Flatten<I> where
I: Iterator,
U: Iterator,
<I as Iterator>::Item: IntoIterator,
<<I as Iterator>::Item as IntoIterator>::IntoIter == U,
<<I as Iterator>::Item as IntoIterator>::Item == <U as Iterator>::Item, type Item = <U as Iterator>::Item;`
`fn flatten(self) -> Flatten<Self> where
Self::Item: IntoIterator,` 1.29.0[src]

Creates an iterator that flattens nested structure. Read more

####
ⓘImportant traits for Fuse<I>

### Important traits for Fuse<I>

`impl<I> Iterator for Fuse<I> where
I: FusedIterator, impl<I> Iterator for Fuse<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn fuse(self) -> Fuse<Self>`[src]

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

####
ⓘImportant traits for Inspect<I, F>

### Important traits for Inspect<I, F>

`impl<I, F> Iterator for Inspect<I, F> where
F: FnMut(&<I as Iterator>::Item),
I: Iterator, type Item = <I as Iterator>::Item;`
`fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),` [src]

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

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn by_ref(&mut self) -> &mut Self`[src]

Borrows an iterator, rather than consuming it. Read more

#### `#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"] fn collect<B>(self) -> B where
B: FromIterator<Self::Item>,` [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,` [src]

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

#### `fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
P: FnMut(&T) -> bool,
Self: DoubleEndedIterator<Item = &'a mut T>,
T: 'a,` [src]

🔬 This is a nightly-only experimental API. (`iter_partition_in_place` #62543)

new API

Reorder the elements of this iterator in-place according to the given predicate, such that all those that return `true` precede all those that return `false`. Returns the number of `true` elements found. Read more

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

🔬 This is a nightly-only experimental API. (`iter_is_partitioned` #62544)

new API

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return `true` precede all those that return `false`. Read more

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

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more

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

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

#### `fn find_map<B, F>(&mut self, f: F) -> Option<B> where
F: FnMut(Self::Item) -> Option<B>,` 1.30.0[src]

Applies function to the elements of iterator and returns the first non-none result. Read more

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

Returns the maximum element of an iterator. Read more

#### `fn min(self) -> Option<Self::Item> where
Self::Item: Ord,` [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

####
ⓘImportant traits for Rev<I>

### Important traits for Rev<I>

`impl<I> Iterator for Rev<I> where
I: DoubleEndedIterator, type Item = <I as Iterator>::Item;`
`fn rev(self) -> Rev<Self> where
Self: DoubleEndedIterator,` [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)>,` [src]

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

####
ⓘImportant traits for Copied<I>

### Important traits for Copied<I>

`impl<'a, I, T> Iterator for Copied<I> where
I: Iterator<Item = &'a T>,
T: 'a + Copy, type Item = T;`
`fn copied<'a, T>(self) -> Copied<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Copy,` 1.36.0[src]

Creates an iterator which copies all of its elements. Read more

####
ⓘImportant traits for Cloned<I>

### Important traits for Cloned<I>

`impl<'a, I, T> Iterator for Cloned<I> where
I: Iterator<Item = &'a T>,
T: 'a + Clone, type Item = T;`
`fn cloned<'a, T>(self) -> Cloned<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Clone,` [src]

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

####
ⓘImportant traits for Cycle<I>

### Important traits for Cycle<I>

`impl<I> Iterator for Cycle<I> where
I: Clone + Iterator, type Item = <I as Iterator>::Item;`
`fn cycle(self) -> Cycle<Self> where
Self: Clone,` [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 cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
I: IntoIterator,` [src]

🔬 This is a nightly-only experimental API. (`iter_order_by` #64295)

Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. 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 partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
I: IntoIterator,` [src]

🔬 This is a nightly-only experimental API. (`iter_order_by` #64295)

Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. 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 eq_by<I, F>(self, other: I, eq: F) -> bool where
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
I: IntoIterator,` [src]

🔬 This is a nightly-only experimental API. (`iter_order_by` #64295)

Determines if the elements of this `Iterator` are equal to those of another with respect to the specified equality function. 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

#### `fn is_sorted(self) -> bool where
Self::Item: PartialOrd<Self::Item>,` [src]

🔬 This is a nightly-only experimental API. (`is_sorted` #53485)

new API

Checks if the elements of this iterator are sorted. Read more

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

🔬 This is a nightly-only experimental API. (`is_sorted` #53485)

new API

Checks if the elements of this iterator are sorted using the given comparator function. Read more

#### `fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,` [src]

🔬 This is a nightly-only experimental API. (`is_sorted` #53485)

new API

Checks if the elements of this iterator are sorted using the given key extraction function. Read more

### `impl<I> Debug for Fuse<I> where
I: Debug,` [src]

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

Formats the value using the given formatter. Read more

### `impl<I> Clone for Fuse<I> where
I: Clone,` [src]

####
ⓘImportant traits for Fuse<I>

### Important traits for Fuse<I>

`impl<I> Iterator for Fuse<I> where
I: FusedIterator, impl<I> Iterator for Fuse<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn clone(&self) -> Fuse<I>`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`[src]

Performs copy-assignment from `source`. Read more

### `impl<I> ExactSizeIterator for Fuse<I> where
I: ExactSizeIterator,` [src]

#### `fn len(&self) -> usize`[src]

Returns the exact number of times the iterator will iterate. Read more

#### `fn is_empty(&self) -> bool`[src]

🔬 This is a nightly-only experimental API. (`exact_size_is_empty` #35428)

Returns `true` if the iterator is empty. Read more

## Auto Trait Implementations

### `impl<I> UnwindSafe for Fuse<I> where
I: UnwindSafe,`

### `impl<I> RefUnwindSafe for Fuse<I> where
I: RefUnwindSafe,`

### `impl<I> Unpin for Fuse<I> where
I: Unpin,`

### `impl<I> Send for Fuse<I> where
I: Send,`

### `impl<I> Sync for Fuse<I> where
I: Sync,`

## Blanket Implementations

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<I> IntoIterator for I where
I: Iterator,` [src]

#### `type Item = <I as Iterator>::Item`

The type of the elements being iterated over.

#### `type IntoIter = I`

Which kind of iterator are we turning this into?

#### `fn into_iter(self) -> I`[src]

Creates an iterator from a value. Read more

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more