Struct NonEmpty 

pub struct NonEmpty<C> { /* private fields */ }

A Vec<T> guaranteed to contain at least one element.

Unlike NonEmptyVec<T> in karpal-core (which has a structurally different representation with separate head and tail fields), NonEmpty<Vec<T>> wraps a standard Vec<T> with a refinement invariant. Construction is only possible via try_new (which checks) or from_parts (which requires at least one element).

Implementations

impl<T> NonEmpty<Vec<T>>

pub fn try_new(v: Vec<T>) -> Option<NonEmpty<Vec<T>>>

Attempt to construct a NonEmpty<Vec<T>> from a Vec<T>. Returns None if the vector is empty.

pub fn from_parts(head: T, tail: Vec<T>) -> NonEmpty<Vec<T>>

Construct from a head element and remaining tail.

pub fn singleton(value: T) -> NonEmpty<Vec<T>>

Construct a single-element vector.

pub fn head(&self) -> &T

The first element (always exists).

pub fn len(&self) -> usize

Number of elements (always >= 1).

pub fn is_empty(&self) -> bool

Always returns false — a NonEmpty is never empty by construction.

pub fn push(&mut self, value: T)

Push a new element.

pub fn as_slice(&self) -> &[T]

Access the underlying slice.

pub fn into_vec(self) -> Vec<T>

Convert into the underlying Vec<T>, discarding the proof.

pub fn iter(&self) -> Iter<'_, T>

Iterate over references.

pub fn map<U>(self, f: impl FnMut(T) -> U) -> NonEmpty<Vec<U>>

Map a function over all elements, preserving non-emptiness.

Trait Implementations

impl<C> Clone for NonEmpty<C>

where C: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for NonEmpty<C>

where C: Debug,

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

Formats the value using the given formatter.

impl<C> Eq for NonEmpty<C>

where C: Eq,

impl<C> Hash for NonEmpty<C>

where C: Hash,

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

where __H: Hasher,

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<C> Ord for NonEmpty<C>

where C: Ord,

fn cmp(&self, other: &NonEmpty<C>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<C> PartialEq for NonEmpty<C>

where C: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C> PartialOrd for NonEmpty<C>

where C: PartialOrd,

fn partial_cmp(&self, other: &NonEmpty<C>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Semigroup for NonEmpty<Vec<T>>

where T: Semigroup + Clone,

fn combine(self, other: NonEmpty<Vec<T>>) -> NonEmpty<Vec<T>>

impl<C> StructuralPartialEq for NonEmpty<C>

where C: PartialEq,