1.0.0[−][src]Trait kai::iter::ExactSizeIterator
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());
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 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());
fn is_empty(&self) -> bool
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<'_, K, V> ExactSizeIterator for Values<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for Args
[src]
impl<'_, K, V> ExactSizeIterator for Keys<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<K, V> ExactSizeIterator for IntoIter<K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K> ExactSizeIterator for Iter<'_, K>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for ValuesMut<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K> ExactSizeIterator for Drain<'_, K>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for Drain<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<K> ExactSizeIterator for IntoIter<K>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for Iter<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for IterMut<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for ArgsOs
[src]
impl ExactSizeIterator for ToLowercase
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for EscapeUnicode
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for EscapeDefault
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, I> ExactSizeIterator for &'_ mut I where
I: ExactSizeIterator + ?Sized,
[src]
I: ExactSizeIterator + ?Sized,
impl<'_, T> ExactSizeIterator for IterMut<'_, T>
[src]
impl<'_, T> ExactSizeIterator for RChunks<'_, T>
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for Chunks<'_, T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for Iter<'_, T>
[src]
impl<'_, T> ExactSizeIterator for Iter<'_, T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for EscapeDefault
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for ChunksExactMut<'_, T>
[src]
impl ExactSizeIterator for EscapeDebug
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, A> ExactSizeIterator for IterMut<'_, A>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for ToUppercase
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<A> ExactSizeIterator for IntoIter<A>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<T> ExactSizeIterator for IntoIter<T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for RChunksExactMut<'_, T>
[src]
impl<'_, T> ExactSizeIterator for IterMut<'_, T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for RChunksMut<'_, T>
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for ChunksExact<'_, T>
[src]
impl<'a, T> ExactSizeIterator for RChunksExact<'a, T>
[src]
impl<'_, A> ExactSizeIterator for Iter<'_, A>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_> ExactSizeIterator for Bytes<'_>
[src]
impl<'_, T> ExactSizeIterator for Windows<'_, T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for ChunksMut<'_, T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for Iter<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<T> ExactSizeIterator for IntoIter<T>
[src]
impl<T> ExactSizeIterator for IntoIter<T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for Iter<'_, T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for Drain<'_, T>
[src]
impl<'_, T> ExactSizeIterator for IterMut<'_, T>
[src]
impl<T> ExactSizeIterator for IntoIter<T>
[src]
impl<'_, T> ExactSizeIterator for Iter<'_, T>
[src]
impl<'_, K, V> ExactSizeIterator for Keys<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for Drain<'_, T>
[src]
impl<T> ExactSizeIterator for IntoIter<T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for Values<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for IterMut<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<K, V> ExactSizeIterator for IntoIter<K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for Drain<'_, T>
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for Iter<'_, T>
[src]
impl<'_, I> ExactSizeIterator for Splice<'_, I> where
I: Iterator,
[src]
I: Iterator,
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for ValuesMut<'_, K, V>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, T> ExactSizeIterator for IterMut<'_, T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<I> ExactSizeIterator for Box<I> where
I: ExactSizeIterator + ?Sized,
[src]
I: ExactSizeIterator + ?Sized,
impl<'_, T> ExactSizeIterator for Iter<'_, T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K> ExactSizeIterator for Drain<'_, K>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for Drain<'_, K, V>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<K, V> ExactSizeIterator for IntoIter<K, V>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for IterMut<'_, K, V>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<K> ExactSizeIterator for IntoIter<K>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for Values<'_, K, V>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'a, K> ExactSizeIterator for Iter<'a, K>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for Keys<'_, K, V>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for Iter<'_, K, V>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'_, K, V> ExactSizeIterator for ValuesMut<'_, K, V>
fn len(&self) -> usize
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)Implementors
impl ExactSizeIterator for Range<i16>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for Range<i32>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for Range<i8>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for Range<isize>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for Range<u16>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for Range<u32>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for Range<u8>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for Range<usize>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for RangeInclusive<i16>
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for RangeInclusive<i8>
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for RangeInclusive<u16>
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl ExactSizeIterator for RangeInclusive<u8>
[src]
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<'a, I, T> ExactSizeIterator for Cloned<I> where
I: ExactSizeIterator<Item = &'a T>,
T: 'a + Clone,
[src]
I: ExactSizeIterator<Item = &'a T>,
T: 'a + Clone,
impl<'a, I, T> ExactSizeIterator for Copied<I> where
I: ExactSizeIterator<Item = &'a T>,
T: 'a + Copy,
[src]
I: ExactSizeIterator<Item = &'a T>,
T: 'a + Copy,
impl<A, B> ExactSizeIterator for Zip<A, B> where
A: ExactSizeIterator,
B: ExactSizeIterator,
[src]
A: ExactSizeIterator,
B: ExactSizeIterator,
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<A, F> ExactSizeIterator for OnceWith<F> where
F: FnOnce() -> A,
[src]
F: FnOnce() -> A,
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<B, I, F> ExactSizeIterator for Map<I, F> where
F: FnMut(<I as Iterator>::Item) -> B,
I: ExactSizeIterator,
[src]
F: FnMut(<I as Iterator>::Item) -> B,
I: ExactSizeIterator,
impl<I> ExactSizeIterator for Enumerate<I> where
I: ExactSizeIterator,
[src]
I: ExactSizeIterator,
impl<I> ExactSizeIterator for Fuse<I> where
I: ExactSizeIterator,
[src]
I: ExactSizeIterator,
impl<I> ExactSizeIterator for Peekable<I> where
I: ExactSizeIterator,
[src]
I: ExactSizeIterator,
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<I> ExactSizeIterator for Rev<I> where
I: ExactSizeIterator + DoubleEndedIterator,
[src]
I: ExactSizeIterator + DoubleEndedIterator,
impl<I> ExactSizeIterator for Skip<I> where
I: ExactSizeIterator,
[src]
I: ExactSizeIterator,
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<I> ExactSizeIterator for StepBy<I> where
I: ExactSizeIterator,
[src]
I: ExactSizeIterator,
fn len(&self) -> usize
1.0.0[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<I> ExactSizeIterator for Take<I> where
I: ExactSizeIterator,
[src]
I: ExactSizeIterator,
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<I, F> ExactSizeIterator for Inspect<I, F> where
F: FnMut(&<I as Iterator>::Item),
I: ExactSizeIterator,
[src]
F: FnMut(&<I as Iterator>::Item),
I: ExactSizeIterator,
impl<T> ExactSizeIterator for Empty<T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)impl<T> ExactSizeIterator for Once<T>
[src]
fn len(&self) -> usize
[src]
fn is_empty(&self) -> bool
[src]
exact_size_is_empty
)