Struct NonEmpty 

pub struct NonEmpty<T, const N: usize> { /* private fields */ }

An ordered collection of at least one and at most N items.

The first item is a field, so non-emptiness is the shape of the value rather than a property a road checks.

Implementations

impl<T, const N: usize> NonEmpty<T, N>

pub const fn one(value: T) -> Self

A non-empty collection holding exactly one item.

pub fn new(items: Vec<T>) -> Result<Self, NonEmptyError>

Admits one complete ordered offering that is non-empty and under this ceiling.

Errors

Returns Empty when nothing is offered, and Overflow when more than N items are.

pub const fn first(&self) -> &T

The first item, which this list always has.

pub fn split(&self) -> (&T, &[T])

The first item and the rest, in order.

pub fn iter(&self) -> impl Iterator<Item = &T>

Reads the held items in order.

pub fn count(&self) -> usize

How many items are held, which is never zero.

Trait Implementations

impl<T: Clone, const N: usize> Clone for NonEmpty<T, N>

fn clone(&self) -> NonEmpty<T, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const N: usize> Debug for NonEmpty<T, N>

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

Formats the value using the given formatter.

impl<T: Eq, const N: usize> Eq for NonEmpty<T, N>

impl<T: Hash, const N: usize> Hash for NonEmpty<T, N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'held, T, const N: usize> IntoIterator for &'held NonEmpty<T, N>

type Item = &'held T

The type of the elements being iterated over.

type IntoIter = Chain<Once<&'held T>, Iter<'held, T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq, const N: usize> PartialEq for NonEmpty<T, N>

fn eq(&self, other: &NonEmpty<T, N>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T: PartialEq, const N: usize> StructuralPartialEq for NonEmpty<T, N>