Struct non_empty_vec::NonEmpty

pub struct NonEmpty<T>(_);

Non empty vector, ensure non empty by construction. Inherits Vec's methods through Deref trait, not implement DerefMut. Overridden these methods:

• len returns NonZeroUsize and is_empty always returns false.
• first(_mut), last(_mut), split_first(_mut), split_last(_mut) don't return Option.
• pop returns None if there is only one element in it.

Implementations

impl<T> NonEmpty<T>

pub fn new(vec: Vec<T>) -> Option<NonEmpty<T>>

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

pub fn as_mut_slice(&mut self) -> &mut [T]

pub fn as_ptr(&self) -> *const T

pub fn as_mut_ptr(&mut self) -> *const T

pub fn len(&self) -> NonZeroUsize

pub const fn is_empty(&self) -> bool

pub fn first(&self) -> &T

pub fn first_mut(&mut self) -> &mut T

pub fn last(&self) -> &T

pub fn last_mut(&mut self) -> &mut T

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

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

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

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

pub fn pop(&mut self) -> Option<T>

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

Trait Implementations

impl<T> AsMut<[T]> for NonEmpty<T>

fn as_mut(&mut self) -> &mut [T]

Performs the conversion.

impl<T> AsMut<Vec<T>> for NonEmpty<T>

fn as_mut(&mut self) -> &mut Vec<T>

Performs the conversion.

impl<T> AsRef<[T]> for NonEmpty<T>

fn as_ref(&self) -> &[T]

Performs the conversion.

impl<T> AsRef<Vec<T>> for NonEmpty<T>

fn as_ref(&self) -> &Vec<T>

Performs the conversion.

impl<T: Clone> Clone for NonEmpty<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for NonEmpty<T>

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

Formats the value using the given formatter.

impl<T> Deref for NonEmpty<T>

type Target = [T]

The resulting type after dereferencing.

fn deref(&self) -> &[T]

Dereferences the value.

impl<T: Eq> Eq for NonEmpty<T>

impl<T> From<(T, Vec<T>)> for NonEmpty<T>

fn from((x, xs): (T, Vec<T>)) -> NonEmpty<T>

Performs the conversion.

impl<T> From<(Vec<T>, T)> for NonEmpty<T>

fn from((xs, x): (Vec<T>, T)) -> NonEmpty<T>

Performs the conversion.

impl<T, I: SliceIndex<[T]>> Index<I> for NonEmpty<T>

type Output = I::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, I: SliceIndex<[T]>> IndexMut<I> for NonEmpty<T>

fn index_mut(&mut self, index: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> Into<Vec<T>> for NonEmpty<T>

fn into(self) -> Vec<T>

Performs the conversion.

impl<T: Ord> Ord for NonEmpty<T>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<NonEmpty<T>> for NonEmpty<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<NonEmpty<T>> for NonEmpty<T>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> StructuralEq for NonEmpty<T>

impl<T> StructuralPartialEq for NonEmpty<T>

impl<T> TryFrom<Vec<T>> for NonEmpty<T>

type Error = EmptyError

The type returned in the event of a conversion error.

fn try_from(xs: Vec<T>) -> Result<Self, Self::Error>

Performs the conversion.