Trait streaming_iterator::StreamingIterator
[−]
[src]
pub trait StreamingIterator { type Item: ?Sized; fn advance(&mut self); fn get(&self) -> Option<&Self::Item>; fn next(&mut self) -> Option<&Self::Item> { ... } fn size_hint(&self) -> (usize, Option<usize>) { ... } fn all<F>(&mut self, f: F) -> bool where Self: Sized, F: FnMut(&Self::Item) -> bool { ... } fn any<F>(&mut self, f: F) -> bool where Self: Sized, F: FnMut(&Self::Item) -> bool { ... } fn by_ref(&mut self) -> &mut Self where Self: Sized { ... } fn cloned(self) -> Cloned<Self> where Self: Sized, Self::Item: Clone { ... } fn count(self) -> usize where Self: Sized { ... } fn filter<F>(self, f: F) -> Filter<Self, F> where Self: Sized, F: FnMut(&Self::Item) -> bool { ... } fn filter_map<B, F>(self, f: F) -> FilterMap<Self, B, F> where Self: Sized, F: FnMut(&Self::Item) -> Option<B> { ... } fn find<F>(&mut self, f: F) -> Option<&Self::Item> where Self: Sized, F: FnMut(&Self::Item) -> bool { ... } fn fuse(self) -> Fuse<Self> where Self: Sized { ... } fn map<B, F>(self, f: F) -> Map<Self, B, F> where Self: Sized, F: FnMut(&Self::Item) -> B { ... } fn map_ref<B: ?Sized, F>(self, f: F) -> MapRef<Self, F> where Self: Sized, F: Fn(&Self::Item) -> &B { ... } fn nth(&mut self, n: usize) -> Option<&Self::Item> { ... } fn position<F>(&mut self, f: F) -> Option<usize> where Self: Sized, F: FnMut(&Self::Item) -> bool { ... } fn skip(self, n: usize) -> Skip<Self> where Self: Sized { ... } fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where Self: Sized, F: FnMut(&Self::Item) -> bool { ... } fn take(self, n: usize) -> Take<Self> where Self: Sized { ... } fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where Self: Sized, F: FnMut(&Self::Item) -> bool { ... } }
An interface for dealing with streaming iterators.
Associated Types
Required Methods
fn advance(&mut self)
Advances the iterator to the next element.
Iterators start just before the first element, so this should be called before get
.
The behavior of calling this method after the end of the iterator has been reached is unspecified.
fn get(&self) -> Option<&Self::Item>
Returns a reference to the current element of the iterator.
The behavior of calling this method before advance
has been called is unspecified.
Provided Methods
fn next(&mut self) -> Option<&Self::Item>
Advances the iterator and returns the next value.
The behavior of calling this method after the end of the iterator has been reached is unspecified.
The default implementation simply calls advance
followed by get
.
fn size_hint(&self) -> (usize, Option<usize>)
Returns the bounds on the remaining length of the iterator.
fn all<F>(&mut self, f: F) -> bool where Self: Sized, F: FnMut(&Self::Item) -> bool
Determines if all elements of the iterator satisfy a predicate.
fn any<F>(&mut self, f: F) -> bool where Self: Sized, F: FnMut(&Self::Item) -> bool
Determines if any elements of the iterator satisfy a predicate.
fn by_ref(&mut self) -> &mut Self where Self: Sized
Borrows an iterator, rather than consuming it.
This is useful to allow the application of iterator adaptors while still retaining ownership of the original adaptor.
fn cloned(self) -> Cloned<Self> where Self: Sized, Self::Item: Clone
Produces a normal, non-streaming, iterator by cloning the elements of this iterator.
fn count(self) -> usize where Self: Sized
Consumes the iterator, counting the number of remaining elements and returning it.
fn filter<F>(self, f: F) -> Filter<Self, F> where Self: Sized, F: FnMut(&Self::Item) -> bool
Creates an iterator which uses a closure to determine if an element should be yielded.
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, B, F> where Self: Sized, F: FnMut(&Self::Item) -> Option<B>
Creates an iterator which both filters and maps by applying a closure to elements.
fn find<F>(&mut self, f: F) -> Option<&Self::Item> where Self: Sized, F: FnMut(&Self::Item) -> bool
Returns the first element of the iterator that satisfies the predicate.
fn fuse(self) -> Fuse<Self> where Self: Sized
Creates an iterator which is "well behaved" at the beginning and end of iteration.
The behavior of calling get
before iteration has been started, and of continuing to call
advance
after get
has returned None
is normally unspecified, but this guarantees that
get
will return None
in both cases.
fn map<B, F>(self, f: F) -> Map<Self, B, F> where Self: Sized, F: FnMut(&Self::Item) -> B
Creates an iterator which transforms elements of this iterator by passing them to a closure.
fn map_ref<B: ?Sized, F>(self, f: F) -> MapRef<Self, F> where Self: Sized, F: Fn(&Self::Item) -> &B
Creates an iterator which transforms elements of this iterator by passing them to a closure.
Unlike map
, this method takes a closure that returns a reference into the original value.
fn nth(&mut self, n: usize) -> Option<&Self::Item>
Consumes the first n
elements of the iterator, returning the next one.
fn position<F>(&mut self, f: F) -> Option<usize> where Self: Sized, F: FnMut(&Self::Item) -> bool
Returns the index of the first element of the iterator matching a predicate.
fn skip(self, n: usize) -> Skip<Self> where Self: Sized
Creates an iterator which skips the first n
elements.
fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where Self: Sized, F: FnMut(&Self::Item) -> bool
Creates an iterator that skips initial elements matching a predicate.
fn take(self, n: usize) -> Take<Self> where Self: Sized
Creates an iterator which only returns the first n
elements.
fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where Self: Sized, F: FnMut(&Self::Item) -> bool
Creates an iterator which only returns initial elements matching a predicate.
Implementors
impl<'a, I: ?Sized> StreamingIterator for &'a mut I where I: StreamingIterator
impl<I> StreamingIterator for Convert<I> where I: Iterator
impl<I, F> StreamingIterator for Filter<I, F> where I: StreamingIterator, F: FnMut(&I::Item) -> bool
impl<I, B, F> StreamingIterator for FilterMap<I, B, F> where I: StreamingIterator, F: FnMut(&I::Item) -> Option<B>
impl<I> StreamingIterator for Fuse<I> where I: StreamingIterator
impl<I, B, F> StreamingIterator for Map<I, B, F> where I: StreamingIterator, F: FnMut(&I::Item) -> B
impl<I, B: ?Sized, F> StreamingIterator for MapRef<I, F> where I: StreamingIterator, F: Fn(&I::Item) -> &B
impl<I> StreamingIterator for Skip<I> where I: StreamingIterator
impl<I, F> StreamingIterator for SkipWhile<I, F> where I: StreamingIterator, F: FnMut(&I::Item) -> bool
impl<I> StreamingIterator for Take<I> where I: StreamingIterator
impl<I, F> StreamingIterator for TakeWhile<I, F> where I: StreamingIterator, F: FnMut(&I::Item) -> bool