Struct NonEmptyVec

pub struct NonEmptyVec<T> { /* private fields */ }

A vector type which is guaranteed to be non-empty.

New instances must be created with an initial element to ensure that the vector is non-empty. This means that the methods first and last always produce an element of type T.

let v = NonEmptyVec::new(1);
assert_eq!(*v.first(), 1);
assert_eq!(*v.last(), 1);

It is possible to push new elements into the vector, but pop will return None if there is only one element left to ensure that the vector is always nonempty.

let mut v = NonEmptyVec::new(1);
v.push(2);
assert_eq!(v.pop(), Some(2));
assert_eq!(v.pop(), None);

Implementations

impl<T> NonEmptyVec<T>

pub fn new(x: T) -> NonEmptyVec<T>

pub fn first(&self) -> &T

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

pub fn last(&self) -> &T

Returns a reference to the last element.

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

Returns a mutable reference to the last element.

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

Append an element to the vector.

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

Pops the last element of the vector.

This method will return None when there is one element left in the vector to ensure that the vector remains non-empty.

let mut v = NonEmptyVec::new(1);
v.push(2);
assert_eq!(v.pop(), Some(2));
assert_eq!(v.pop(), None);

pub fn len(&self) -> usize

Returns the length of the vector.

let mut v = NonEmptyVec::new(1);
v.push(2);
v.push(3);
assert_eq!(v.len(), 3);

pub fn is_empty(&self) -> bool

Always returns false.

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

Returns an iterator over the vector.

Trait Implementations

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

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: Clone> From<&NonEmptyVec<T>> for Vec<T>

fn from(xs: &NonEmptyVec<T>) -> Vec<T>

Converts to this type from the input type.

impl<T> From<NonEmptyVec<T>> for Vec<T>

fn from(xs: NonEmptyVec<T>) -> Vec<T>

Converts to this type from the input type.

impl<T> Index<&usize> for NonEmptyVec<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> Index<usize> for NonEmptyVec<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<&usize> for NonEmptyVec<T>

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

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

impl<T> IndexMut<usize> for NonEmptyVec<T>

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

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

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

Allows for constructions on the form for t in ts.

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = NonEmptyIter<'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: PartialEq> PartialEq for NonEmptyVec<T>

fn eq(&self, other: &NonEmptyVec<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: Clone> TryFrom<&[T]> for NonEmptyVec<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xs: &[T]) -> Result<NonEmptyVec<T>, Error>

Performs the conversion.

impl<T: Clone, const N: usize> TryFrom<&[T; N]> for NonEmptyVec<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(xs: &[T; N]) -> Result<NonEmptyVec<T>, Error>

Performs the conversion.

impl<T: Clone> TryFrom<&Vec<T>> for NonEmptyVec<T>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

impl<T> StructuralPartialEq for NonEmptyVec<T>