Struct ArrayNonEmptyIterator 

pub struct ArrayNonEmptyIterator<T, const C: usize> { /* private fields */ }

Non-empty iterator for arrays with length > 0.

Examples

Use non-zero length arrays anywhere an IntoNonEmptyIterator is expected.

use std::num::NonZeroUsize;

use nonempty_collections::*;

fn is_one<T>(iter: impl IntoNonEmptyIterator<Item = T>) {
    assert_eq!(NonZeroUsize::MIN, iter.into_nonempty_iter().count());
}

is_one([0]);

Only compiles for non-empty arrays:

use nonempty_collections::*;

fn is_one(iter: impl IntoNonEmptyIterator<Item = usize>) {}

is_one([]); // Doesn't compile because it is empty.

Trait Implementations

impl<T: Clone, const C: usize> Clone for ArrayNonEmptyIterator<T, C>

fn clone(&self) -> ArrayNonEmptyIterator<T, C>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, const C: usize> Debug for ArrayNonEmptyIterator<T, C>

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

Formats the value using the given formatter.

impl<T, const C: usize> IntoIterator for ArrayNonEmptyIterator<T, C>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T, C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, const C: usize> NonEmptyIterator for ArrayNonEmptyIterator<T, C>

fn next(self) -> (Self::Item, Self::IntoIter)

where Self: Sized,

Advances this non-empty iterator, consuming its ownership. Yields the first item and a possibly empty iterator containing the rest of the elements.

fn peekable(self) -> Peekable<Self::IntoIter>

where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information.

fn all<F>(self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate.

fn any<F>(self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate.

fn chain<U>(self, other: U) -> Chain<Self::IntoIter, U::IntoIter>

where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new non-empty iterator over both in sequence.

fn cloned<'a, T>(self) -> Cloned<Self>

where Self: Sized + NonEmptyIterator<Item = &'a T>, T: Clone + 'a,

Creates a non-empty iterator which clones all of its elements.

fn collect<B>(self) -> B

where Self: Sized, B: FromNonEmptyIterator<Self::Item>,

Transforms an iterator into a collection, or some other concrete value.

fn copied<'a, T>(self) -> Copied<Self::IntoIter>

where Self: Sized + NonEmptyIterator<Item = &'a T>, T: Copy + 'a,

Creates a non-empty iterator which copies all of its elements.

fn count(self) -> NonZeroUsize

where Self: Sized,

Consumes the non-empty iterator, counting the number of iterations and returning it.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Creates a non-empty iterator which gives the current iteration count as well as the next value.

fn filter<P>(self, predicate: P) -> Filter<<Self as IntoIterator>::IntoIter, P>

where Self: Sized, P: FnMut(&<Self as IntoIterator>::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 as IntoIterator>::IntoIter, F>

where Self: Sized, F: FnMut(<Self as IntoIterator>::Item) -> Option<B>,

Creates an iterator that both filters and maps.

fn find<P>(self, predicate: P) -> Option<Self::Item>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self::IntoIter, U, F>

where Self: Sized, F: FnMut(Self::Item) -> U, U: IntoNonEmptyIterator,

Creates an iterator that works like map, but flattens nested, non-empty structure.

fn fold<B, F>(self, init: B, f: F) -> B

where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result.

fn group_by<K, F>(self, f: F) -> NEGroupBy<Self, F>

where Self: Sized, F: FnMut(&Self::Item) -> K, K: PartialEq,

Group the non-empty input stream into concrete, non-empty subsections via a given function. The cutoff criterion is whether the return value of f changes between two consecutive elements.

fn map<U, F>(self, f: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> U,

Takes a closure and creates a non-empty iterator which calls that closure on each element.

fn max(self) -> Self::Item

where Self: Sized, Self::Item: Ord,

Returns the maximum element of a non-empty iterator.

fn max_by<F>(self, compare: F) -> Self::Item

where Self: Sized, F: Fn(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the given comparison function.

fn max_by_key<B, F>(self, key: F) -> Self::Item

where Self: Sized, B: Ord, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function.

fn min(self) -> Self::Item

where Self: Sized, Self::Item: Ord,

Returns the minimum element of a non-empty iterator.

fn min_by<F>(self, compare: F) -> Self::Item

where Self: Sized, F: Fn(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the given comparison function.

fn min_by_key<B, F>(self, key: F) -> Self::Item

where Self: Sized, B: Ord, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function.

fn sorted_by_key<K, F>(self, f: F) -> IntoIter<Self::Item>

where Self: Sized, K: Ord, F: FnMut(&Self::Item) -> K,

Sort all iterator elements into a new non-empty iterator in ascending order.

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

where Self: Sized,

Returns the nth element of the iterator.

fn skip(self, n: usize) -> Skip<<Self as IntoIterator>::IntoIter>

where Self: Sized,

Skip the first n elements.

fn skip_while<P>( self, pred: P, ) -> SkipWhile<<Self as IntoIterator>::IntoIter, P>

where Self: Sized, P: FnMut(&<Self as IntoIterator>::Item) -> bool,

Skips over all initial elements that pass a given predicate.

fn sum<S>(self) -> S

where Self: Sized + IntoIterator, S: Sum<<Self as IntoIterator>::Item>,

Sums the elements of a non-empty iterator.

fn take(self, n: NonZeroUsize) -> Take<Self>

where Self: Sized,

Iterates over the first n elements, or fewer if the underlying iterator ends sooner.

fn take_while<P>( self, pred: P, ) -> TakeWhile<<Self as IntoIterator>::IntoIter, P>

where Self: Sized, P: FnMut(&<Self as IntoIterator>::Item) -> bool,

Iterates over all initial elements that pass a given predicate.

fn product<P>(self) -> P

where Self: Sized + IntoIterator, P: Product<<Self as IntoIterator>::Item>,

Iterates over the entire non-empty iterator, multiplying all the elements.

fn zip<U>(self, other: U) -> Zip<Self::IntoIter, U::IntoIter>

where Self: Sized, U: IntoNonEmptyIterator,

“Zips up” two non-empty iterators into a single one, while preserving non-emptiness.

fn reduce<F>(self, f: F) -> Self::Item

where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation.