Struct NonEmpty 

pub struct NonEmpty<I: Iterator> { /* private fields */ }

An iterator source guaranteed to yield at least one item.

Examples

use commonware_utils::iter::NonEmpty;

let items = NonEmpty::try_new([1, 2, 3].into_iter()).expect("items are non-empty");
assert_eq!(items.into_iter().collect::<Vec<_>>(), vec![1, 2, 3]);

Implementations

impl<I: Iterator> NonEmpty<I>

pub const fn new(first: I::Item, rest: I) -> Self

Creates a non-empty iterator from a first item and the remaining items.

pub fn try_new(items: I) -> Option<Self>

Creates a non-empty iterator from items, or returns None when it is empty.

pub fn into_parts(self) -> (I::Item, I)

Consumes this source, returning its first item and remaining iterator.

Trait Implementations

impl<I: Clone + Iterator> Clone for NonEmpty<I>

where I::Item: Clone,

fn clone(&self) -> NonEmpty<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug + Iterator> Debug for NonEmpty<I>

where I::Item: Debug,

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

Formats the value using the given formatter.

impl<I: Iterator> IntoIterator for NonEmpty<I>

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = Chain<Once<<I as Iterator>::Item>, I>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.