Struct List

pub struct List<T: ?Sized + ListItem<ID>, const ID: u64 = 0> { /* private fields */ }

A linked list.

All elements in this linked list will be ListArc references to the value. Since a value can only have one ListArc (for each pair of prev/next pointers), this ensures that the same prev/next pointers are not used for several linked lists.

Invariants

• If the list is empty, then first is null. Otherwise, first points at the ListLinks field of the first element in the list.
• All prev/next pointers in ListLinks fields of items in the list are valid and form a cycle.
• For every item in the list, the list owns the associated ListArc reference and has exclusive access to the ListLinks field.

Implementations

impl<T: ?Sized + ListItem<ID>, const ID: u64> List<T, ID>

pub const fn new() -> Self

Creates a new empty list.

pub fn is_empty(&self) -> bool

Returns whether this list is empty.

pub fn push_back(&mut self, item: ListArc<T, ID>)

Add the provided item to the back of the list.

pub fn push_front(&mut self, item: ListArc<T, ID>)

Add the provided item to the front of the list.

pub fn pop_back(&mut self) -> Option<ListArc<T, ID>>

Removes the last item from this list.

pub fn pop_front(&mut self) -> Option<ListArc<T, ID>>

Removes the first item from this list.

pub unsafe fn remove(&mut self, item: &T) -> Option<ListArc<T, ID>>

Removes the provided item from this list and returns it.

This returns None if the item is not in the list. (Note that by the safety requirements, this means that the item is not in any list.)

Safety

item must not be in a different linked list (with the same id).

pub fn push_all_back(&mut self, other: &mut List<T, ID>)

Moves all items from other into self.

The items of other are added to the back of self, so the last item of other becomes the last item of self.

pub fn cursor_front(&mut self) -> Option<Cursor<'_, T, ID>>

Returns a cursor to the first element of the list.

If the list is empty, this returns None.

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

Creates an iterator over the list.

Trait Implementations

impl<T: ?Sized + ListItem<ID>, const ID: u64> Default for List<T, ID>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized + ListItem<ID>, const ID: u64> Drop for List<T, ID>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: ?Sized + ListItem<ID>, const ID: u64> IntoIterator for &'a List<T, ID>

type IntoIter = Iter<'a, T, ID>

Which kind of iterator are we turning this into?

type Item = ArcBorrow<'a, T>

The type of the elements being iterated over.

fn into_iter(self) -> Iter<'a, T, ID>

Creates an iterator from a value.

impl<T: ?Sized + ListItem<ID>, const ID: u64> IntoIterator for List<T, ID>

type IntoIter = IntoIter<T, ID>

Which kind of iterator are we turning this into?

type Item = ListArc<T, ID>

The type of the elements being iterated over.

fn into_iter(self) -> IntoIter<T, ID>

Creates an iterator from a value.

impl<T, const ID: u64> Send for List<T, ID>

where ListArc<T, ID>: Send, T: ?Sized + ListItem<ID>,

impl<T, const ID: u64> Sync for List<T, ID>

where ListArc<T, ID>: Sync, T: ?Sized + ListItem<ID>,