Struct DLinkedList 

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

Available on crate feature dlist only.

An intrusive doubly linked list.

Supports O(1) insertion and removal at both ends.

Implementations

impl<P, Tag> DLinkedList<P, Tag>

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

pub fn new() -> Self

Creates a new, empty doubly 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 unsafe fn peak(&mut self, ptr: *mut P::Target)

Moves a node to the front of the list (e.g., for LRU updates).

Safety

The pointer ptr must be valid and pointing to an element currently in the list or a valid free element if properly managed (though typically used for re-ordering).

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

Pushes an element to the front of the list.

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

Pushes an element to the back of the list.

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

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

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

Removes and returns the element at the back of the list.

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 print<U: Debug>(&self)

Available on crate feature std only.

pub fn iter<'a>(&'a self) -> DLinkedListIterator<'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) -> DLinkedListDrainer<'a, P, Tag>

Returns a draining iterator that removes items from the list. Crucial for cleaning up lists containing owned pointers (like Box).

Note

The iterator removes elements from the front of the list (FIFO order),

Trait Implementations

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

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

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

Formats the value using the given formatter.

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

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

fn drop(&mut self)

Executes the destructor for this type.

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

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