Struct cordyceps::List

pub struct List<T: ?Sized> { /* private fields */ }

An intrusive doubly-linked list.

This data structure may be used as a first-in, first-out queue by using the List::push_front and List::pop_back methods. It also supports random-access removals using the List::remove method.

In order to be part of a List, a type T must implement Linked for list::Links<T>.

Implementations

impl<T: ?Sized> List<T>

pub const fn new() -> List<T>

Returns a new empty list.

pub fn is_empty(&self) -> bool

Returns true if this list is empty.

impl<T: Linked<Links<T>> + ?Sized> List<T>

pub fn assert_valid(&self)

Asserts as many of the linked list’s invariants as possible.

pub fn push_front(&mut self, item: T::Handle)

Appends an item to the head of the list.

pub fn pop_back(&mut self) -> Option<T::Handle>

Removes an item from the tail of the list.

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

Remove an arbitrary node from the list.

Safety

The caller must ensure that the removed node is an element of this linked list, and not any other linked list.

pub fn cursor(&mut self) -> Cursor<'_, T>

Returns a Cursor over the items in this list.

The Cursor type can be used as a mutable Iterator. In addition, however, it also permits modifying the structure of the list by inserting or removing elements at the cursor’s current position.

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

Returns an iterator over the items in this list, by reference.

Trait Implementations

impl<T: Linked<Links<T>> + ?Sized> Debug for List<T>

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

Formats the value using the given formatter.

impl<T: Linked<Links<T>> + ?Sized> Send for List<T> where
    T: Send, 

impl<T: Linked<Links<T>> + ?Sized> Sync for List<T> where
    T: Sync,