Struct linked_list::List

pub struct List<G: AdapterWrapped> { /* private fields */ }

A linked list.

Elements in the list are wrapped and ownership is transferred to the list while the element is in the list.

Implementations

impl<G: AdapterWrapped> List<G>

pub const fn new() -> Self

Constructs a new empty linked list.

pub const fn is_empty(&self) -> bool

Returns whether the list is empty.

pub fn push_back(&mut self, data: G::Wrapped)

Adds the given object to the end (back) of the list.

It is dropped if it’s already on this (or another) list; this can happen for reference-counted objects, so dropping means decrementing the reference count.

pub unsafe fn insert_after( &mut self, existing: NonNull<G::EntryType>, data: G::Wrapped )

Inserts the given object after existing.

It is dropped if it’s already on this (or another) list; this can happen for reference-counted objects, so dropping means decrementing the reference count.

Safety

Callers must ensure that existing points to a valid entry that is on the list.

pub unsafe fn remove(&mut self, data: &G::Wrapped) -> Option<G::Wrapped>

Removes the given entry.

Safety

Callers must ensure that data is either on this list. It being on another list leads to memory unsafety.

pub fn pop_front(&mut self) -> Option<G::Wrapped>

Removes the element currently at the front of the list and returns it.

Returns None if the list is empty.

pub fn front(&self) -> Option<&G::EntryType>

Returns the first element of the list, if one exists.

pub fn back(&self) -> Option<&G::EntryType>

Returns the last element of the list, if one exists.

pub fn cursor_front(&self) -> Cursor<'_, G>

Returns a cursor starting on the first (front) element of the list.

Trait Implementations

impl<G: AdapterWrapped> Default for List<G>

fn default() -> Self

Returns the “default value” for a type.

impl<G: AdapterWrapped> Drop for List<G>

fn drop(&mut self)

Executes the destructor for this type.