Trait nom::lib::std::iter::ExactSizeIterator

[+] Show declaration

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

[−] Expand description

An iterator that knows its exact length.

Many Iterators 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());

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

Provided methods

fn len(&self) -> usize[−]

Returns the exact length of the iterator.

The implementation ensures that the iterator will return exactly len() more times a Some(T) value, before returning None. 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());

fn is_empty(&self) -> bool[−]

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

Returns true if 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 = std::iter::once(0);
assert!(!one_element.is_empty());

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

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

Implementations on Foreign Types

impl ExactSizeIterator for ArgsOs[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl ExactSizeIterator for Args[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl ExactSizeIterator for EscapeDefault[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl ExactSizeIterator for ToUppercase

impl<const N: usize, T> ExactSizeIterator for IntoIter<T, N> where
    [T; N]: LengthAtMost32, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl ExactSizeIterator for EscapeDefault

impl ExactSizeIterator for EscapeDebug

impl ExactSizeIterator for ToLowercase

impl ExactSizeIterator for EscapeUnicode[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, I> ExactSizeIterator for &'_ mut I where
    I: ExactSizeIterator + ?Sized, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<K> ExactSizeIterator for IntoIter<K>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for IterMut<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for Keys<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'a, K> ExactSizeIterator for Iter<'a, K>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K> ExactSizeIterator for Drain<'_, K>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<K, V> ExactSizeIterator for IntoIter<K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for Drain<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for Iter<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for ValuesMut<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for Values<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

Implementors

impl ExactSizeIterator for Range<usize>

impl ExactSizeIterator for Range<isize>

impl ExactSizeIterator for Range<i16>

impl ExactSizeIterator for Range<i32>

impl ExactSizeIterator for Range<i8>

impl ExactSizeIterator for Range<u16>

impl ExactSizeIterator for Range<u32>

impl ExactSizeIterator for Range<u8>

impl ExactSizeIterator for RangeInclusive<i16>

impl ExactSizeIterator for RangeInclusive<i8>

impl ExactSizeIterator for RangeInclusive<u16>

impl ExactSizeIterator for RangeInclusive<u8>

impl<'_> ExactSizeIterator for Bytes<'_>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<'_, A> ExactSizeIterator for nom::lib::std::option::Iter<'_, A>

impl<'_, A> ExactSizeIterator for nom::lib::std::option::IterMut<'_, A>

impl<'_, I> ExactSizeIterator for Splice<'_, I> where
    I: Iterator, 

impl<'_, K> ExactSizeIterator for nom::lib::std::collections::hash_set::Drain<'_, K>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K> ExactSizeIterator for nom::lib::std::collections::hash_set::Iter<'_, K>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::hash_map::Values<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::hash_map::ValuesMut<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::hash_map::Keys<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::hash_map::IterMut<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::hash_map::Iter<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::hash_map::Drain<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::btree_map::Keys<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::btree_map::ValuesMut<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::btree_map::Values<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::btree_map::IterMut<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, K, V> ExactSizeIterator for nom::lib::std::collections::btree_map::Iter<'_, K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, T> ExactSizeIterator for ChunksMut<'_, T>

impl<'_, T> ExactSizeIterator for nom::lib::std::result::IterMut<'_, T>

impl<'_, T> ExactSizeIterator for Windows<'_, T>

impl<'_, T> ExactSizeIterator for RChunksExactMut<'_, T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for nom::lib::std::slice::Iter<'_, T>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for ChunksExact<'_, T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for nom::lib::std::slice::IterMut<'_, T>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for RChunks<'_, T>

impl<'_, T> ExactSizeIterator for ChunksExactMut<'_, T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for nom::lib::std::result::Iter<'_, T>

impl<'_, T> ExactSizeIterator for RChunksMut<'_, T>

impl<'_, T> ExactSizeIterator for Chunks<'_, T>

impl<'_, T> ExactSizeIterator for nom::lib::std::collections::vec_deque::IterMut<'_, T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for nom::lib::std::collections::linked_list::Iter<'_, T>

impl<'_, T> ExactSizeIterator for nom::lib::std::collections::vec_deque::Drain<'_, T>

impl<'_, T> ExactSizeIterator for nom::lib::std::collections::vec_deque::Iter<'_, T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for nom::lib::std::vec::Drain<'_, T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for nom::lib::std::collections::btree_set::Iter<'_, T>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<'_, T> ExactSizeIterator for nom::lib::std::collections::binary_heap::Drain<'_, T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for nom::lib::std::collections::linked_list::IterMut<'_, T>

impl<'_, T> ExactSizeIterator for nom::lib::std::collections::binary_heap::Iter<'_, T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<'_, T> ExactSizeIterator for DrainSorted<'_, T> where
    T: Ord, 

impl<'a, I, T> ExactSizeIterator for Cloned<I> where
    I: ExactSizeIterator<Item = &'a T>,
    T: 'a + Clone, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<'a, I, T> ExactSizeIterator for Copied<I> where
    I: ExactSizeIterator<Item = &'a T>,
    T: 'a + Copy, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<'a, T> ExactSizeIterator for RChunksExact<'a, T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<A> ExactSizeIterator for nom::lib::std::option::IntoIter<A>

impl<A, B> ExactSizeIterator for Zip<A, B> where
    A: ExactSizeIterator,
    B: ExactSizeIterator, 

impl<A, F> ExactSizeIterator for OnceWith<F> where
    F: FnOnce() -> A, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<B, I, F> ExactSizeIterator for Map<I, F> where
    F: FnMut(<I as Iterator>::Item) -> B,
    I: ExactSizeIterator, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<I> ExactSizeIterator for Enumerate<I> where
    I: ExactSizeIterator, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<I> ExactSizeIterator for Fuse<I> where
    I: ExactSizeIterator, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<I> ExactSizeIterator for Peekable<I> where
    I: ExactSizeIterator, 

impl<I> ExactSizeIterator for Rev<I> where
    I: ExactSizeIterator + DoubleEndedIterator, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<I> ExactSizeIterator for Skip<I> where
    I: ExactSizeIterator, 

impl<I> ExactSizeIterator for StepBy<I> where
    I: ExactSizeIterator, 

impl<I> ExactSizeIterator for Take<I> where
    I: ExactSizeIterator, 

impl<I> ExactSizeIterator for Box<I> where
    I: ExactSizeIterator + ?Sized, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<I, F> ExactSizeIterator for Inspect<I, F> where
    F: FnMut(&<I as Iterator>::Item),
    I: ExactSizeIterator, [−]

[+] Show hidden undocumented items

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

impl<K> ExactSizeIterator for nom::lib::std::collections::hash_set::IntoIter<K>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<K, V> ExactSizeIterator for nom::lib::std::collections::hash_map::IntoIter<K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<K, V> ExactSizeIterator for nom::lib::std::collections::btree_map::IntoIter<K, V>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<T> ExactSizeIterator for Once<T>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<T> ExactSizeIterator for Empty<T>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<T> ExactSizeIterator for nom::lib::std::result::IntoIter<T>

impl<T> ExactSizeIterator for nom::lib::std::vec::IntoIter<T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<T> ExactSizeIterator for nom::lib::std::collections::vec_deque::IntoIter<T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<T> ExactSizeIterator for nom::lib::std::collections::binary_heap::IntoIter<T>[−]

[+] Show hidden undocumented items

fn is_empty(&self) -> bool

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

impl<T> ExactSizeIterator for nom::lib::std::collections::btree_set::IntoIter<T>[−]

[+] Show hidden undocumented items

fn len(&self) -> usize

impl<T> ExactSizeIterator for nom::lib::std::collections::linked_list::IntoIter<T>

impl<T> ExactSizeIterator for IntoIterSorted<T> where
    T: Ord, 

impl<'a> ExactSizeIterator for Values<'a>

impl<'a> ExactSizeIterator for OsValues<'a>

impl<L, R> ExactSizeIterator for Either<L, R> where     L: ExactSizeIterator,     R: ExactSizeIterator<Item = L::Item>,

impl<I> ExactSizeIterator for Step<I> where     I: ExactSizeIterator,

impl<I, R> ExactSizeIterator for MapInto<I, R> where     I: ExactSizeIterator,     I::Item: Into<R>,

impl<I, F> ExactSizeIterator for Update<I, F> where     I: ExactSizeIterator,     F: FnMut(&mut I::Item),

impl<I> ExactSizeIterator for ExactlyOneError<I> where     I: ExactSizeIterator,

impl<I> ExactSizeIterator for MultiPeek<I> where     I: ExactSizeIterator,

impl<I, F> ExactSizeIterator for PadUsing<I, F> where     I: ExactSizeIterator,     F: FnMut(usize) -> I::Item,

impl<A> ExactSizeIterator for RepeatN<A> where     A: Clone,

impl<I> ExactSizeIterator for Tee<I> where     I: ExactSizeIterator,     I::Item: Clone,

impl<T> ExactSizeIterator for TupleBuffer<T> where     T: TupleCollect,

impl<I> ExactSizeIterator for WithPosition<I> where     I: ExactSizeIterator,

impl<I, J> ExactSizeIterator for ZipEq<I, J> where     I: ExactSizeIterator,     J: ExactSizeIterator,

impl<T, U> ExactSizeIterator for ZipLongest<T, U> where     T: ExactSizeIterator,     U: ExactSizeIterator,

impl<A> ExactSizeIterator for Zip<(A,)> where     A: ExactSizeIterator,

impl<A, B> ExactSizeIterator for Zip<(A, B)> where     A: ExactSizeIterator,     B: ExactSizeIterator,

impl<A, B, C> ExactSizeIterator for Zip<(A, B, C)> where     A: ExactSizeIterator,     B: ExactSizeIterator,     C: ExactSizeIterator,

impl<A, B, C, D> ExactSizeIterator for Zip<(A, B, C, D)> where     A: ExactSizeIterator,     B: ExactSizeIterator,     C: ExactSizeIterator,     D: ExactSizeIterator,

impl<A, B, C, D, E> ExactSizeIterator for Zip<(A, B, C, D, E)> where     A: ExactSizeIterator,     B: ExactSizeIterator,     C: ExactSizeIterator,     D: ExactSizeIterator,     E: ExactSizeIterator,

impl<A, B, C, D, E, F> ExactSizeIterator for Zip<(A, B, C, D, E, F)> where     A: ExactSizeIterator,     B: ExactSizeIterator,     C: ExactSizeIterator,     D: ExactSizeIterator,     E: ExactSizeIterator,     F: ExactSizeIterator,

impl<A, B, C, D, E, F, G> ExactSizeIterator for Zip<(A, B, C, D, E, F, G)> where     A: ExactSizeIterator,     B: ExactSizeIterator,     C: ExactSizeIterator,     D: ExactSizeIterator,     E: ExactSizeIterator,     F: ExactSizeIterator,     G: ExactSizeIterator,

impl<A, B, C, D, E, F, G, H> ExactSizeIterator for Zip<(A, B, C, D, E, F, G, H)> where     A: ExactSizeIterator,     B: ExactSizeIterator,     C: ExactSizeIterator,     D: ExactSizeIterator,     E: ExactSizeIterator,     F: ExactSizeIterator,     G: ExactSizeIterator,     H: ExactSizeIterator,

impl<'a> ExactSizeIterator for IndexVecIter<'a>

impl ExactSizeIterator for IndexVecIntoIter

impl<'a, S: Index<usize, Output = T> + ?Sized + 'a, T: 'a> ExactSizeIterator for SliceChooseIter<'a, S, T>

impl<'a> ExactSizeIterator for Iter<'a>

impl<'a> ExactSizeIterator for IterMut<'a>

impl ExactSizeIterator for IntoIter

impl<'a> ExactSizeIterator for Keys<'a>

impl<'a> ExactSizeIterator for Values<'a>

impl<'a> ExactSizeIterator for ValuesMut<'a>

impl<'a, T: Array> ExactSizeIterator for Drain<'a, T>

impl<A: Array> ExactSizeIterator for IntoIter<A>

impl<'a, T, P> ExactSizeIterator for Pairs<'a, T, P>

impl<'a, T, P> ExactSizeIterator for PairsMut<'a, T, P>

impl<T, P> ExactSizeIterator for IntoPairs<T, P>

impl<T> ExactSizeIterator for IntoIter<T>

impl<'a, T> ExactSizeIterator for Iter<'a, T>

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

impl<'a, T: Send + 'a> ExactSizeIterator for CachedIterMut<'a, T>

impl<T: Send> ExactSizeIterator for CachedIntoIter<T>

impl<'a, T: Send + 'a> ExactSizeIterator for IterMut<'a, T>

impl<T: Send> ExactSizeIterator for IntoIter<T>

impl<'a, V> ExactSizeIterator for Iter<'a, V>

impl<'a, V> ExactSizeIterator for IterMut<'a, V>

impl<'a, V> ExactSizeIterator for Drain<'a, V>

impl<'a, V> ExactSizeIterator for Keys<'a, V>

impl<'a, V> ExactSizeIterator for Values<'a, V>

impl<'a, V> ExactSizeIterator for ValuesMut<'a, V>

impl<V> ExactSizeIterator for IntoIter<V>