Struct oom::NonEmptyVec

pub struct NonEmptyVec<T: Sized> { /* fields omitted */ }

A non-empty vector type, counterpart of Vec<T>.

Implementations

impl<T: Sized> NonEmptyVec<T>

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

Converts a Vec<T> into a NonEmptyVec.

Panics

This function will panic if passed Vec is empty.

pub fn from_vec_checked(vec: Vec<T>) -> Result<Self, Vec<T>>

Converts a Vec<T> into a NonEmptyVec. Returns passed Vec if it is empty.

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

Returns a raw pointer to the vector's buffer.

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

Returns an unsafe mutable pointer to the vector's buffer.

pub fn as_nonempty_slice(&self) -> NonEmptySlice<'_, T>

Returns a non-empty slice from this vec.

pub fn as_nonempty_mut_slice(&mut self) -> NonEmptyMutSlice<'_, T>

Returns a non-empty mutable slice from this vec.

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

Extracts a slice containing the entire vector.

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

Extracts a mutable slice of the entire vector.

pub fn len(&self) -> NonZeroUsize

Returns the number of elements in the vector.

pub fn is_empty(&self) -> bool

Always returns false because the vector is non-empty.

pub fn capacity(&self) -> NonZeroUsize

Returns the number of elements the vector can hold without reallocating.

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

Converts self into a vector without clones or allocations.

pub fn to_vec(&self) -> Vec<T> where
    T: Clone, 

Copies self into a new Vec.

pub fn first(&self) -> &T

A shorthand for NonEmptyMutSlice::first.

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

A shorthand for NonEmptyMutSlice::first_mut.

pub fn last(&self) -> &T

A shorthand for NonEmptyMutSlice::last.

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

A shorthand for NonEmptyMutSlice::last_mut.

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

A shorthand for NonEmptyMutSlice::split_first.

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

A shorthand for NonEmptyMutSlice::split_first_mut.

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

A shorthand for NonEmptyMutSlice::split_last.

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

A shorthand for NonEmptyMutSlice::split_last_mut.

Trait Implementations

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

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

Performs the conversion.

impl<T: Clone> Clone for NonEmptyVec<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Eq> Eq for NonEmptyVec<T>

impl<T: Ord> Ord for NonEmptyVec<T>

fn cmp(&self, other: &Self) -> 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<NonEmptyVec<T>> for NonEmptyVec<T>

fn eq(&self, other: &Self) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<NonEmptyVec<T>> for NonEmptyVec<T>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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