Struct streaming_iterator::FlatMap

pub struct FlatMap<I, J, F> { /* fields omitted */ }

A streaming iterator that maps elements to iterators with a closure and then yields the concatenation of the obtained iterators

Trait Implementations

impl<I: Debug, J: Debug, F: Debug> Debug for FlatMap<I, J, F>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<I, J, F> StreamingIterator for FlatMap<I, J, F> where
    I: StreamingIterator,
    F: FnMut(&I::Item) -> J,
    J: StreamingIterator, 

type Item = J::Item

The type of the elements being iterated over.

fn advance(&mut self)

Advances the iterator to the next element.

fn get(&self) -> Option<&Self::Item>

Returns a reference to the current element of the iterator.

fn fold<Acc, Fold>(self, init: Acc, fold: Fold) -> Acc where
    Self: Sized,
    Fold: FnMut(Acc, &Self::Item) -> Acc, 

Reduces the iterator's elements to a single, final value.

fn next(&mut self) -> Option<&Self::Item>

Advances the iterator and returns the next value.

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.

fn chain<I>(self, other: I) -> Chain<Self, I> where
    Self: Sized,
    I: StreamingIterator<Item = Self::Item> + Sized, 

Consumes two iterators and returns a new iterator that iterates over both in sequence.

Important traits for Cloned<I>

impl<I> Iterator for Cloned<I> where
    I: StreamingIterator,
    I::Item: Clone,  type Item = I::Item;

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 flat_map<J, F>(self, f: F) -> FlatMap<Self, J, F> where
    Self: Sized,
    J: StreamingIterator,
    F: FnMut(&Self::Item) -> J, 

Creates an iterator which flattens iterators obtained by applying a closure to elements. Note that the returned iterators must be streaming iterators.

Important traits for FilterMapDeref<I, F>

impl<I, B, F> Iterator for FilterMapDeref<I, F> where
    I: StreamingIterator,
    F: FnMut(&I::Item) -> Option<B>,  type Item = B;

fn filter_map_deref<B, F>(self, f: F) -> FilterMapDeref<Self, F> where
    Self: Sized,
    F: FnMut(&Self::Item) -> Option<B>, 

Creates a regular, non-streaming 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.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item),
    Self: Sized, 

Call a closure on each element, passing the element on. The closure is called upon calls to advance or advance_back, and exactly once per element regardless of how many times (if any) get is called.

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.

Important traits for MapDeref<I, F>

impl<I, B, F> Iterator for MapDeref<I, F> where
    I: StreamingIterator,
    F: FnMut(&I::Item) -> B,  type Item = B;

fn map_deref<B, F>(self, f: F) -> MapDeref<Self, F> where
    Self: Sized,
    F: FnMut(&Self::Item) -> B, 

Creates a regular, non-streaming 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.

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

Consumes the first n elements of the iterator, returning the next one.

Important traits for Owned<I>

impl<I> Iterator for Owned<I> where
    I: StreamingIterator,
    I::Item: ToOwned,  type Item = <I::Item as ToOwned>::Owned;

fn owned(self) -> Owned<Self> where
    Self: Sized,
    Self::Item: ToOwned, 

Creates a normal, non-streaming, iterator with elements produced by calling to_owned on the elements of this iterator.

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.

fn rev(self) -> Rev<Self> where
    Self: Sized + DoubleEndedStreamingIterator, 

Creates an iterator which returns elemens in the opposite order.

fn for_each<F>(self, f: F) where
    Self: Sized,
    F: FnMut(&Self::Item), 

Calls a closure on each element of an iterator.