core::iter::ExactSizeIterator - Rust
Description: API documentation for the Rust `ExactSizeIterator` trait in crate `core`.
Keywords: rust, rustlang, rust-lang, ExactSizeIterator

# Trait core::iter::ExactSizeIterator 1.0.0 [−] [src]

    pub trait ExactSizeIterator: Iterator {
        fn len(&self) -> usize { ... }
        fn is_empty(&self) -> bool { ... }
    }

An iterator that knows its exact length.

Many `Iterator`s don't know how many times they will iterate, but some do. If an iterator knows how many times it can iterate, providing access to that information can be useful. For example, if you want to iterate backwards, a good start is to know where the end is.

When implementing an `ExactSizeIterator`, You must also implement `Iterator`. When doing so, the implementation of `size_hint` must return the exact size of the iterator.

The `len` method has a default implementation, so you usually shouldn't implement it. However, you may be able to provide a more performant implementation than the default, so overriding it in this case makes sense.

# Examples

Basic usage:

    // a finite range knows exactly how many times it will iterate
    let five = 0..5;

    assert_eq!(5, five.len());Run

In the module level docs, we implemented an `Iterator`, `Counter`. Let's implement `ExactSizeIterator` for it as well:

    impl ExactSizeIterator for Counter {
        // We can easily calculate the remaining number of iterations.
        fn len(&self) -> usize {
            5 - self.count
        }
    }

    // And now we can use it!

    let counter = Counter::new();

    assert_eq!(5, counter.len());Run

## Provided Methods

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

Returns the exact number of times the iterator will iterate.

This method has a default implementation, so you usually should not implement it directly. However, if you can provide a more efficient implementation, you can do so. See the trait-level docs for an example.

This function has the same safety guarantees as the `size_hint` function.

# Examples

Basic usage:

    // a finite range knows exactly how many times it will iterate
    let five = 0..5;

    assert_eq!(5, five.len());Run

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

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

Returns whether the iterator is empty.

This method has a default implementation using `self.len()`, so you don't need to implement it yourself.

# Examples

Basic usage:

    #![feature(exact_size_is_empty)]

    let mut one_element = 0..1;
    assert!(!one_element.is_empty());

    assert_eq!(one_element.next(), Some(0));
    assert!(one_element.is_empty());

    assert_eq!(one_element.next(), None);Run

## Implementors

- [src]
  `impl ExactSizeIterator for EscapeUnicode`
- [src]
  `impl ExactSizeIterator for EscapeDefault`
- [src]
  `impl ExactSizeIterator for EscapeDebug`
- [src]
  `impl ExactSizeIterator for Range<usize>`
- [src]
  `impl ExactSizeIterator for Range<u8>`
- [src]
  `impl ExactSizeIterator for Range<u16>`
- [src]
  `impl ExactSizeIterator for Range<u32>`
- [src]
  `impl ExactSizeIterator for Range<isize>`
- [src]
  `impl ExactSizeIterator for Range<i8>`
- [src]
  `impl ExactSizeIterator for Range<i16>`
- [src]
  `impl ExactSizeIterator for Range<i32>`
- [src]
  `impl ExactSizeIterator for RangeInclusive<u8>`
- [src]
  `impl ExactSizeIterator for RangeInclusive<u16>`
- [src]
  `impl ExactSizeIterator for RangeInclusive<i8>`
- [src]
  `impl ExactSizeIterator for RangeInclusive<i16>`
- [src]
  `impl<T> ExactSizeIterator for Empty<T>`
- [src]
  `impl<T> ExactSizeIterator for Once<T>`
- `impl<'a, I: ExactSizeIterator + ?Sized> ExactSizeIterator for &'a mut I`
- [src]
  `impl<I> ExactSizeIterator for Rev<I> where
  I: ExactSizeIterator + DoubleEndedIterator,`
- [src]
  `impl<'a, I, T: 'a> ExactSizeIterator for Cloned<I> where
  I: ExactSizeIterator<Item = &'a T>,
  T: Clone,`
- [src]
  `impl<I> ExactSizeIterator for StepBy<I> where
  I: ExactSizeIterator,`
- [src]
  `impl<A, B> ExactSizeIterator for Zip<A, B> where
  A: ExactSizeIterator,
  B: ExactSizeIterator,`
- [src]
  `impl<B, I: ExactSizeIterator, F> ExactSizeIterator for Map<I, F> where
  F: FnMut(I::Item) -> B,`
- [src]
  `impl<I> ExactSizeIterator for Enumerate<I> where
  I: ExactSizeIterator,`
- [src]
  `impl<I: ExactSizeIterator> ExactSizeIterator for Peekable<I>`
- [src]
  `impl<I> ExactSizeIterator for Skip<I> where
  I: ExactSizeIterator,`
- [src]
  `impl<I> ExactSizeIterator for Take<I> where
  I: ExactSizeIterator,`
- [src]
  `impl<I> ExactSizeIterator for Fuse<I> where
  I: ExactSizeIterator,`
- [src]
  `impl<I: ExactSizeIterator, F> ExactSizeIterator for Inspect<I, F> where
  F: FnMut(&I::Item),`
- [src]
  `impl<'a, A> ExactSizeIterator for core::option::Iter<'a, A>`
- [src]
  `impl<'a, A> ExactSizeIterator for core::option::IterMut<'a, A>`
- [src]
  `impl<A> ExactSizeIterator for core::option::IntoIter<A>`
- [src]
  `impl<'a, T> ExactSizeIterator for core::result::Iter<'a, T>`
- [src]
  `impl<'a, T> ExactSizeIterator for core::result::IterMut<'a, T>`
- [src]
  `impl<T> ExactSizeIterator for core::result::IntoIter<T>`
- [src]
  `impl<'a, T> ExactSizeIterator for core::slice::Iter<'a, T>`
- [src]
  `impl<'a, T> ExactSizeIterator for core::slice::IterMut<'a, T>`
- [src]
  `impl<'a, T> ExactSizeIterator for Windows<'a, T>`
- [src]
  `impl<'a, T> ExactSizeIterator for Chunks<'a, T>`
- [src]
  `impl<'a, T> ExactSizeIterator for ChunksMut<'a, T>`
- [src]
  `impl<'a> ExactSizeIterator for Bytes<'a>`

# 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
+ / -
  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`)