Struct List

#[repr(C)]
pub struct List<T> { /* private fields */ }

An arena-allocated singly-linked list.

Linked lists are often a poor choice because they aren’t very cache-friendly. However, this linked list implementation should be cache-friendly, since the individual cells are allocated out of an arena.

Implementations

impl<T> List<T>

pub fn new_arena() -> ListArena<T>

Creates a new ListArena that will manage lists of this type.

pub fn is_empty(&self) -> bool

Returns whether this list is empty.

pub fn empty() -> List<T>

Returns an empty list.

pub fn from_handle(handle: Handle<ListCell<T>>) -> List<T>

pub fn handle(&self) -> Handle<ListCell<T>>

Returns a handle to the head of the list.

pub fn push_front(&mut self, arena: &mut ListArena<T>, head: T)

Pushes a new element onto the front of this list.

pub fn pop_front<'a>(&mut self, arena: &'a ListArena<T>) -> Option<&'a T>

Removes and returns the element at the front of this list. If the list is empty, returns None.

pub fn iter<'a>( self, arena: &'a ListArena<T>, ) -> impl Iterator<Item = &'a T> + 'a

Returns an iterator over the elements of this list.

impl<T> List<T>

pub fn equals_with<F>(self, arena: &ListArena<T>, other: List<T>, eq: F) -> bool

where F: FnMut(&T, &T) -> bool,

pub fn cmp_with<F>( self, arena: &ListArena<T>, other: List<T>, cmp: F, ) -> Ordering

where F: FnMut(&T, &T) -> Ordering,

impl<T> List<T>

where T: Eq,

pub fn equals(self, arena: &ListArena<T>, other: List<T>) -> bool

impl<T> List<T>

where T: Ord,

pub fn cmp(self, arena: &ListArena<T>, other: List<T>) -> Ordering

Trait Implementations

impl<T> Clone for List<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Niche for List<T>

where Handle<ListCell<T>>: Niche,

type Output = MaybeUninit<List<T>>

The type that is used to store values of Self inside of a ControlledOption. This might be Self itself, if your niche is a valid instance of the type, but which violates some runtime constraint. But if you cannot easily create your niche as an instance of Self, you can use some other type, you can use some other type instead.

fn none() -> Self::Output

Returns the niche value for this type that should be used to represent None for a ControlledOption.

fn is_none(value: &Self::Output) -> bool

Returns whether value is the niche value for this type.

fn into_some(value: Self) -> Self::Output

Transforms a non-niche value of this type into its Output type. When Output is Self, this will be the identity function.

fn from_some(value: Self::Output) -> Self

Transforms a non-niche value of this type from its Output type. When Output is Self, this will be the identity function.

impl<T> Copy for List<T>