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

# Struct std::result::IterMut 1.0.0 [−] [src]

    pub struct IterMut<'a, T> where T: 'a { /* fields omitted */ }

An iterator over a mutable reference to the `Ok` variant of a `Result`.

## Trait Implementations

### `impl<'a, T> FusedIterator for IterMut<'a, T>`

### `impl<'a, T> Iterator for IterMut<'a, T>`

#### `type Item = &'a mut T`

The type of the elements being iterated over.

#### `fn next(&mut self) -> Option<&'a mut T>`

Advances the iterator and returns the next value. Read more

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

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

#### `fn count(self) -> usize`

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

#### `fn last(self) -> Option<Self::Item>`

Consumes the iterator, returning the last element. Read more

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

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

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

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

#### `fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter> where U: IntoIterator`

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

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

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

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

Creates an iterator that both filters and maps. Read more

#### `fn enumerate(self) -> Enumerate<Self>`

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

#### `fn peekable(self) -> Peekable<Self>`

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`

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`

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

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

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

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

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

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`

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

#### `fn fuse(self) -> Fuse<Self>`

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) -> ()`

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

#### `fn by_ref(&mut self) -> &mut Self`

Borrows an iterator, rather than consuming it. Read more

#### `fn collect<B>(self) -> B where B: FromIterator<Self::Item>`

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`

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

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

An iterator adaptor 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`

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`

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`

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`

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`

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`

Returns the maximum element of an iterator. Read more

#### `fn min(self) -> Option<Self::Item> where Self::Item: Ord`

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

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`

Unstable (`iter_max_by` #36105)

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

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`

Unstable (`iter_min_by` #36105)

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`

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

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`

Creates an iterator which `clone()`s all of its elements. Read more

#### `fn cycle(self) -> Cycle<Self> where Self: Clone`

Repeats an iterator endlessly. Read more

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

Sums the elements of an iterator. Read more

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

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

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::Item>`
1.5.0

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::Item>`
1.5.0

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::Item>`
1.5.0

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::Item>`
1.5.0

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::Item>`
1.5.0

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::Item>`
1.5.0

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::Item>`
1.5.0

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

### `impl<'a, A> TrustedLen for IterMut<'a, A>`

### `impl<'a, T> DoubleEndedIterator for IterMut<'a, T>`

#### `fn next_back(&mut self) -> Option<&'a mut T>`

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

### `impl<'a, T> Debug for IterMut<'a, T> where T: 'a + Debug`

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>`

Formats the value using the given formatter.

### `impl<'a, T> ExactSizeIterator for IterMut<'a, T>`

#### `fn len(&self) -> usize`

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

#### `fn is_empty(&self) -> bool`

Unstable (`exact_size_is_empty` #35428)

Returns whether the iterator is empty. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand 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`)