Struct SLinkedList 

pub struct SLinkedList<P, Tag>
where
    P: Pointer,
    P::Target: SListItem<Tag>,
{ /* private fields */ }

Available on crate feature slist only.

A singly linked list with head and tail pointers (FIFO queue).

Supports O(1) push to back and pop from front.

Implementations

impl<P, Tag> SLinkedList<P, Tag>

where P: Pointer, P::Target: SListItem<Tag>,

pub fn new() -> Self

Creates a new, empty singly linked list.

pub fn clear(&mut self)

Clears the list pointers. Note: This does NOT drop the elements. Use drain or drop if you need to release owned resources.

pub fn get_length(&self) -> u64

Returns the length of the list.

pub fn len(&self) -> usize

Returns the length of the list as usize.

pub fn is_empty(&self) -> bool

Returns true if the list contains no elements.

pub fn push_back(&mut self, item: P)

Appends an element to the back of the list (FIFO: enqueue).

pub fn pop_front(&mut self) -> Option<P>

Removes the first element and returns it (FIFO: dequeue).

pub fn get_front(&self) -> Option<&P::Target>

Returns a reference to the front element.

pub fn get_back(&self) -> Option<&P::Target>

Returns a reference to the back element.

pub fn is_front(&self, node: &P::Target) -> bool

Checks if the given node is the head of the list.

pub fn iter<'a>(&'a self) -> SLinkedListIterator<'a, P, Tag>

Returns an iterator over the list (borrowed).

NOTE

If you plan on turn the raw pointer to owned, use drain instead

Safety

The caller must ensure that the list is not modified in a way that can invalidate internal pointers (such as removing elements or dropping items) for the duration of the iterator’s use.

pub fn drain<'a>(&'a mut self) -> SLinkedListDrainer<'a, P, Tag>

Returns a draining iterator that removes items from the list.

Trait Implementations

impl<P, Tag> Debug for SLinkedList<P, Tag>

where P: Pointer + Debug, P::Target: SListItem<Tag>,

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

Formats the value using the given formatter.

impl<P, Tag> Drop for SLinkedList<P, Tag>

where P: Pointer, P::Target: SListItem<Tag>,

fn drop(&mut self)

Executes the destructor for this type.

impl<P, Tag> Send for SLinkedList<P, Tag>

where P: Pointer, P::Target: SListItem<Tag>,