Struct NonEmptyVec 

pub struct NonEmptyVec<T> {
    pub head: T,
    pub tail: Vec<T>,
}

A vector guaranteed to contain at least one element.

Follows the “Parse, don’t validate” pattern: the non-empty invariant is established once via NonEmptyVec::from_vec or TryFrom<Vec<T>>, and NonEmptyVec::first is then infallible (returns &T, not Option<&T>).

The shape mirrors the nonempty crate discussed in Eli Bendersky’s “Rusty thoughts on Parse, don’t validate”: head holds the first element, tail holds the rest, so no indexing or unwrap is needed downstream.

use vtcode_commons::validation::NonEmptyVec;

let parsed = NonEmptyVec::from_vec(vec!["a", "b"]).expect("non-empty");
assert_eq!(parsed.first(), &"a");
assert!(NonEmptyVec::<String>::from_vec(Vec::new()).is_none());

Fields

head: T

First element; always present.

tail: Vec<T>

Remaining elements; possibly empty.

Implementations

impl<T> NonEmptyVec<T>

pub const fn new(head: T) -> NonEmptyVec<T>

Create a singleton collection from one element.

pub const fn singleton(head: T) -> NonEmptyVec<T>

Alias for NonEmptyVec::new, matching the nonempty crate naming.

pub fn from_vec(vec: Vec<T>) -> Option<NonEmptyVec<T>>

Parse a Vec into a non-empty collection, returning None when empty.

This is the single boundary where the invariant is established. Order is preserved: head is the original vec[0].

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

Infallible access to the first element; no Option to re-check.

pub fn last(&self) -> &T

Access the last element.

pub fn len(&self) -> usize

Number of elements; always >= 1.

pub const fn is_empty(&self) -> bool

Always returns false; provided for generic len/is_empty pairing.

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

Iterate over all elements in order.

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

Append an element to the end.

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

Consume into a plain Vec, preserving order.

Trait Implementations

impl<T> Clone for NonEmptyVec<T>

where T: Clone,

fn clone(&self) -> NonEmptyVec<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for NonEmptyVec<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for NonEmptyVec<T>

where T: Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<NonEmptyVec<T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Eq for NonEmptyVec<T>

where T: Eq,

impl<T> PartialEq for NonEmptyVec<T>

where T: PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for NonEmptyVec<T>

where T: Serialize,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for NonEmptyVec<T>

where T: PartialEq,

impl<T> TryFrom<Vec<T>> for NonEmptyVec<T>

type Error = EmptyCollectionError

The type returned in the event of a conversion error.

fn try_from( value: Vec<T>, ) -> Result<NonEmptyVec<T>, <NonEmptyVec<T> as TryFrom<Vec<T>>>::Error>

Performs the conversion.