Struct NonEmptyStack 

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

A stack that ALWAYS have at least one element.

Implementations

impl<T> NonEmptyStack<T>

A stack that always have at least one element, where the last element can be frequently accessed

pub const fn new(value: T) -> NonEmptyStack<T>

pub fn with_capacity(value: T, capacity: usize) -> NonEmptyStack<T>

pub fn from_vec(stack: Vec<T>) -> Option<NonEmptyStack<T>>

pub fn len(&self) -> usize

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

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

pub fn clear_and_keep_last(&mut self)

Clear the stack and keep the last element

use hexga_utils::prelude::*;

let mut stack = NonEmptyStack::from_vec(vec![1,2,3,4]).unwrap();
stack.clear_and_keep_last();
assert_eq!(stack.len(), 1);
assert_eq!(stack.last(), &4);

pub fn clear_and_keep_first(&mut self)

Clear the stack and keep the first element

use hexga_utils::prelude::*;

let mut stack = NonEmptyStack::from_vec(vec![1,2,3,4]).unwrap();
stack.clear_and_keep_first();
assert_eq!(stack.len(), 1);
assert_eq!(stack.last(), &1);

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

Clear the stack and keep passed value

pub fn clear(&mut self)

where T: Default,

Clear the stack and keep defaut value

pub fn replace(&mut self, value: T) -> T

Replace the last value

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

pub fn duplicate(&mut self) -> &mut NonEmptyStack<T>

where T: Clone,

Clone the last element and push it

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

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

pub fn iter_mut(&mut self) -> NonEmptyStackIterMut<'_, T>

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

Trait Implementations

impl<T> Capacity for NonEmptyStack<T>

fn capacity(&self) -> usize

impl<T> Clone for NonEmptyStack<T>

where T: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for NonEmptyStack<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for NonEmptyStack<T>

where T: Default,

fn default() -> NonEmptyStack<T>

Returns the “default value” for a type.

impl<T> Deref for NonEmptyStack<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<NonEmptyStack<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for NonEmptyStack<T>

fn deref_mut(&mut self) -> &mut <NonEmptyStack<T> as Deref>::Target

Mutably dereferences the value.

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

where T: Deserialize<'de>,

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Get<usize> for NonEmptyStack<T>

type Output = T

fn get(&self, index: usize) -> Option<&<NonEmptyStack<T> as Get<usize>>::Output>

Returns a reference to the value.

unsafe fn get_unchecked( &self, index: usize, ) -> &<NonEmptyStack<T> as Get<usize>>::Output

Returns a reference to the value.

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

Returns a reference to the value.

fn is_index_valid(&self, index: Idx) -> bool

True if get(index) return Some, false otherwise.

fn is_index_invalid(&self, index: Idx) -> bool

True if get(index) return None, false otherwise.

fn contains(&self, index: Idx) -> bool

impl<T> GetManyMut<usize> for NonEmptyStack<T>

fn try_get_many_mut<const N: usize>( &mut self, indices: [usize; N], ) -> Result<[&mut <NonEmptyStack<T> as Get<usize>>::Output; N], GetDisjointMutError>

fn get_many_mut<const N: usize>( &mut self, indices: [Idx; N], ) -> Option<[&mut Self::Output; N]>

Returns multiples mutables references to the values. All values that can be accessed with the indices must be disjoint.

fn get_many_mut_or_panic<const N: usize>( &mut self, indices: [Idx; N], ) -> [&mut Self::Output; N]

Returns multiples mutables references to the values. All values that can be accessed with the indices must be disjoint.

unsafe fn get_many_unchecked_mut<const N: usize>( &mut self, indices: [Idx; N], ) -> [&mut Self::Output; N]

Returns multiples mutables references to the values. All values that can be accessed with the indices must be disjoint.

fn swap(&mut self, a: Idx, b: Idx) -> bool

where Self::Output: Sized,

Swaps the values at two mutable locations, without deinitializing either one.

fn swap_or_panic(&mut self, a: Idx, b: Idx)

where Self::Output: Sized,

Swaps the values at two mutable locations, without deinitializing either one.

unsafe fn swap_unchecked(&mut self, a: Idx, b: Idx)

where Self::Output: Sized,

Swaps the values at two mutable locations, without deinitializing either one.

impl<T> GetMut<usize> for NonEmptyStack<T>

fn get_mut( &mut self, index: usize, ) -> Option<&mut <NonEmptyStack<T> as Get<usize>>::Output>

Returns a mutable reference to the value.

unsafe fn get_unchecked_mut( &mut self, index: usize, ) -> &mut <NonEmptyStack<T> as Get<usize>>::Output

Returns a mutable reference to the value.

fn get_mut_or_panic(&mut self, index: Idx) -> &mut Self::Output

fn replace(&mut self, index: Idx, value: Self::Output) -> Option<Self::Output>

where Self::Output: Sized,

Replace the value and return the old one.

fn replace_or_panic(&mut self, index: Idx, value: Self::Output) -> Self::Output

where Self::Output: Sized,

Replace the value and return the old one.

unsafe fn replace_unchecked( &mut self, index: Idx, value: Self::Output, ) -> Self::Output

where Self::Output: Sized,

Replace the value and return the old one.

fn set(&mut self, index: Idx, value: Self::Output) -> bool

where Self::Output: Sized,

Set the value and drop the previous one.

fn set_or_panic(&mut self, index: Idx, value: Self::Output) -> &mut Self

where Self::Output: Sized,

Set the value and drop the previous one.

unsafe fn set_unchecked(&mut self, index: Idx, value: Self::Output) -> &mut Self

where Self::Output: Sized,

impl<T> Hash for NonEmptyStack<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 NonEmptyStack<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &<NonEmptyStack<T> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for NonEmptyStack<T>

fn index_mut( &mut self, index: usize, ) -> &mut <NonEmptyStack<T> as Index<usize>>::Output

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

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

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = NonEmptyStackIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a NonEmptyStack<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = NonEmptyStackIterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut NonEmptyStack<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for NonEmptyStack<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = NonEmptyStackIntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <NonEmptyStack<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> Length for NonEmptyStack<T>

fn len(&self) -> usize

fn is_empty(&self) -> bool

True if the container contains 0 elements.

fn is_not_empty(&self) -> bool

True if the container contains at least one element. Will always be different than is_empty().

impl<T> Ord for NonEmptyStack<T>

where T: Ord,

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for NonEmptyStack<T>

where T: PartialEq,

fn eq(&self, other: &NonEmptyStack<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> PartialOrd for NonEmptyStack<T>

where T: PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Reserve for NonEmptyStack<T>

fn reserve(&mut self, additional: usize)

fn reserve_exact(&mut self, additional: usize)

fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>

fn reserve_total(&mut self, total: usize)

where Self: Length,

Ensure total capacity is at least total. Does nothing if the current capacity is already >= total.

fn try_reserve_total(&mut self, total: usize) -> Result<(), TryReserveError>

where Self: Length,

Ensure total capacity is at least total. Does nothing if the current capacity is already >= total.

fn reserve_total_exact(&mut self, total: usize)

where Self: Length,

Ensure total capacity is at least total. Does nothing if the current capacity is already >= total.

fn try_reserve_total_exact( &mut self, total: usize, ) -> Result<(), TryReserveError>

where Self: Length,

Ensure total capacity is at least total. Does nothing if the current capacity is already >= total.

impl<T> Serialize for NonEmptyStack<T>

where T: Serialize,

Available on crate feature serde only.

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> Shrink for NonEmptyStack<T>

fn shrink_to_fit(&mut self)

Shrinks the capacity as much as possible.

fn shrink_to(&mut self, min_capacity: usize)

Shrinks the capacity with a lower bound. The capacity will remain at least as large as both the length and the supplied value. If the current capacity is less than the lower limit, this is a no-op.

impl<T> Truncate for NonEmptyStack<T>

fn truncate(&mut self, len: usize)

Shortens it, keeping the first len elements and dropping the rest.

impl<T> TryFrom<Vec<T>> for NonEmptyStack<T>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithCapacity for NonEmptyStack<T>

type Param = T

fn with_capacity_and_param( capacity: usize, value: <NonEmptyStack<T> as WithCapacity>::Param, ) -> NonEmptyStack<T>

fn with_capacity(capacity: usize) -> Self

where Self: Sized, Self::Param: Default,

impl<T> Collection for NonEmptyStack<T>

impl<T> CollectionBijective for NonEmptyStack<T>

impl<T> Eq for NonEmptyStack<T>

where T: Eq,

impl<T> StructuralPartialEq for NonEmptyStack<T>