Struct ConstList

pub struct ConstList<'a, T: 'a>(/* private fields */);

📦 An immutable, append-only, linear, functional, non-contiguous, list.

A safe, predictable, and lightweight structure, suitable where immutability is an asset and compile-time guarantees matter more than list manipulation.

Example

const MY_LIST: ConstList<'static, i32> = ConstList::new()
    .push(2)
    .push(4)
    .push(8);

assert_eq!(8, *MY_LIST.pop().0.unwrap());

Vendored

This is adapted work from const_list.

Implementations

impl<'a, T: 'a> ConstList<'a, T>

pub const fn new() -> Self

Creates a new, empty list.

pub const fn get(&self, index: usize) -> Option<&T>

Gets a reference to the item at the provided index in this list, if any.

pub const fn len(&self) -> usize

Determines the length of this list.

pub const fn is_empty(&self) -> bool

Whether the list is empty.

pub const fn push(&'a self, value: T) -> Self

Pushes a new item onto the beginning of this list, producing a new list head.

pub const fn pop(&'a self) -> (Option<&'a T>, &'a Self)

Removes the first item (if any) from this list, and produces the rest of the list.

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

Creates an iterator over the contents of the list.

Trait Implementations

impl<'a, T: Clone + 'a> Clone for ConstList<'a, T>

fn clone(&self) -> ConstList<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> ConstDefault for ConstList<'_, T>

const DEFAULT: Self

Returns the compile-time “default value” for a type.

impl<'a, T: Debug + 'a> Debug for ConstList<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Default + 'a> Default for ConstList<'a, T>

fn default() -> ConstList<'a, T>

Returns the “default value” for a type.

impl<'a, T: Hash + 'a> Hash for ConstList<'a, 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<'a, T> IntoIterator for &'a ConstList<'a, T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = ConstListIterator<'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: PartialEq + 'a> PartialEq for ConstList<'a, T>

fn eq(&self, other: &ConstList<'a, 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<'a, T: Copy + 'a> Copy for ConstList<'a, T>

impl<'a, T: Eq + 'a> Eq for ConstList<'a, T>

impl<'a, T: 'a> StructuralPartialEq for ConstList<'a, T>