Struct NEVec 

pub struct NEVec<T>(/* private fields */);

Non-empty vector type.

Implementations

impl<T> NEVec<T>

pub fn new(head: T, tail: Vec<T>) -> Self

Creates a new NEVec, ensuring at least one element is present.

pub fn singleton(value: T) -> Self

Creates a new singleton NEVec. Semantically equivalent to:

NEVec::new(value, Vec::new());

pub fn head(&self) -> &T

Returns the first element. This operation is safe as the invariant guarantees at least one element is present.

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

Returns all elements except the last one. This may be empty if the NEVec is a singleton.

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

Returns all elements except the first one. This may be empty if the NEVec is a singleton.

pub fn last(&self) -> &T

Returns the last element. This operation is safe as the invariant guarantees at least one element is present.

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

Attempts to create a NEVec from a Vec, returning None if the Vec is empty.

assert!(NEVec::from_vec(vec![42]).is_ok());
assert!(NEVec::from_vec(Vec::<u32>::new()).is_err());

pub fn from_deque(deque: VecDeque<T>) -> Result<Self, NonEmptyError>

Attempts to create a NEVec from a VecDeque, returning None if the VecDeque is empty.

assert!(NEVec::from_deque(VecDeque::from(vec![42])).is_ok());
assert!(NEVec::from_deque(VecDeque::<u32>::new()).is_err());

pub fn len(&self) -> usize

Returns the length of this NEVec.

pub fn is_empty(&self) -> bool

A NEVec is always non-empty.

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

Returns this NEVec as a slice.

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

Pushes an element to the front of the NEVec.

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

Pushes an element to the back of the NEVec.

pub fn pop_front(&mut self) -> Result<T, NonEmptyError>

Tries to remove the first element.

pub fn pop_back(&mut self) -> Result<T, NonEmptyError>

Tries to remove the last element.

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

Splits the NEVec into the first element and the rest. This operation is guaranteed to succeed because the invariant guarantees at least one element is present.

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

Splits the NEVec into all elements except the last one and the last element. This operation is guaranteed to succeed because the invariant guarantees at least one element is present.

pub fn take_split_first(self) -> (T, IntoIter<T>)

Like NEVec::split_first, but consumes the NEVec.

pub fn take_split_last(self) -> (IntoIter<T>, T)

Like NEVec::split_last, but consumes the NEVec.

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

Returns an iterator over the elements of the NEVec.

pub fn extend<I: IntoIterator<Item = T>>(&mut self, other: I)

Extends the NEVec with the elements from another collection.

Trait Implementations

impl<T: Clone> Clone for NEVec<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for NEVec<T>

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

Formats the value using the given formatter.

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

fn from(value: (T, Vec<T>)) -> Self

Converts to this type from the input type.

impl<T> From<(T, VecDeque<T>)> for NEVec<T>

fn from(value: (T, VecDeque<T>)) -> Self

Converts to this type from the input type.

impl<T> From<NEVec<T>> for Vec<T>

fn from(ne: NEVec<T>) -> Self

Converts to this type from the input type.

impl<T> From<NEVec<T>> for VecDeque<T>

fn from(ne: NEVec<T>) -> Self

Converts to this type from the input type.

impl<T> From<T> for NEVec<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for NEVec<T>

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<T> Index<usize> for NEVec<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, T> IntoIterator for &'a NEVec<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut NEVec<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for NEVec<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<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> PartialEq for NEVec<T>

fn eq(&self, other: &NEVec<T>) -> 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<T> TryFrom<Vec<T>> for NEVec<T>

type Error = NonEmptyError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T: Eq> Eq for NEVec<T>

impl<T> StructuralPartialEq for NEVec<T>