Trait tskit::prelude::StreamingIterator[−][src]

pub trait StreamingIterator {
    type Item: ?Sized;

Show 29 methods    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
        F: FnMut(&Self::Item) -> bool,
    { ... }

    fn any<F>(&mut self, f: F) -> bool
    where
        F: FnMut(&Self::Item) -> bool,
    { ... }

    fn by_ref(&mut self) -> &mut Self { ... }

    fn chain<I>(self, other: I) -> Chain<Self, I>
    where
        I: StreamingIterator<Item = Self::Item>,
    { ... }

    fn cloned(self) -> Cloned<Self>
    where
        Self::Item: Clone,
    { ... }

    fn count(self) -> usize { ... }

    fn filter<F>(self, f: F) -> Filter<Self, F>
    where
        F: FnMut(&Self::Item) -> bool,
    { ... }

    fn filter_map<B, F>(self, f: F) -> FilterMap<Self, B, F>
    where
        F: FnMut(&Self::Item) -> Option<B>,
    { ... }

    fn flat_map<J, F>(self, f: F) -> FlatMap<Self, J, F>
    where
        J: StreamingIterator,
        F: FnMut(&Self::Item) -> J,
    { ... }

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

    fn find<F>(&mut self, f: F) -> Option<&Self::Item>
    where
        F: FnMut(&Self::Item) -> bool,
    { ... }

    fn fuse(self) -> Fuse<Self> { ... }

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

    fn map<B, F>(self, f: F) -> Map<Self, B, F>
    where
        F: FnMut(&Self::Item) -> B,
    { ... }

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

    fn map_ref<B, F>(self, f: F) -> MapRef<Self, F>
    where
        F: Fn(&Self::Item) -> &B,
        B: ?Sized,
    { ... }

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

    fn position<F>(&mut self, f: F) -> Option<usize>
    where
        F: FnMut(&Self::Item) -> bool,
    { ... }

    fn skip(self, n: usize) -> Skip<Self> { ... }

    fn skip_while<F>(self, f: F) -> SkipWhile<Self, F>
    where
        F: FnMut(&Self::Item) -> bool,
    { ... }

    fn take(self, n: usize) -> Take<Self> { ... }

    fn take_while<F>(self, f: F) -> TakeWhile<Self, F>
    where
        F: FnMut(&Self::Item) -> bool,
    { ... }

    fn rev(self) -> Rev<Self>
    where
        Self: DoubleEndedStreamingIterator,
    { ... }

    fn fold<B, F>(self, init: B, f: F) -> B
    where
        F: FnMut(B, &Self::Item) -> B,
    { ... }

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

}
Expand description

An interface for dealing with streaming iterators.

Associated Types

The type of the elements being iterated over.

Required methods

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.

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

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.

Returns the bounds on the remaining length of the iterator.

Determines if all elements of the iterator satisfy a predicate.

Determines if any elements of the iterator satisfy a predicate.

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.

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

Produces a normal, non-streaming, iterator by cloning the elements of this iterator.

Consumes the iterator, counting the number of remaining elements and returning it.

Creates an iterator which uses a closure to determine if an element should be yielded.

Creates an iterator which both filters and maps by applying a closure to elements.

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

Creates a regular, non-streaming iterator which both filters and maps by applying a closure to elements.

Returns the first element of the iterator that satisfies the predicate.

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.

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.

Creates an iterator which transforms elements of this iterator by passing them to a closure.

Creates a regular, non-streaming iterator which transforms elements of this iterator by passing them to a closure.

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.

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

Returns the index of the first element of the iterator matching a predicate.

Creates an iterator which skips the first n elements.

Creates an iterator that skips initial elements matching a predicate.

Creates an iterator which only returns the first n elements.

Creates an iterator which only returns initial elements matching a predicate.

Creates an iterator which returns elemens in the opposite order.

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

Calls a closure on each element of an iterator.

Implementations on Foreign Types

Implementors