Struct intrusive_collections::xor_linked_list::XorLinkedList

pub struct XorLinkedList<A: Adapter> where
    A::LinkOps: XorLinkedListOps,  { /* fields omitted */ }

Intrusive xor doubly-linked list which uses less memory than a regular doubly linked list

In exchange for less memory use, it is impossible to create a cursor from a pointer to an element.

When this collection is dropped, all elements linked into it will be converted back to owned pointers and dropped.

Implementations

impl<A: Adapter> XorLinkedList<A> where
    A::LinkOps: XorLinkedListOps, 

pub fn new(adapter: A) -> XorLinkedList<A>

Creates an empty XorLinkedList.

pub fn is_empty(&self) -> bool

Returns true if the XorLinkedList is empty.

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

Returns a null Cursor for this list.

pub fn cursor_mut(&mut self) -> CursorMut<'_, A>

Returns a null CursorMut for this list.

pub unsafe fn cursor_from_ptr_and_prev(
    &self,
    ptr: *const <A::PointerOps as PointerOps>::Value,
    prev: *const <A::PointerOps as PointerOps>::Value
) -> Cursor<'_, A>

Creates a Cursor from a pointer to an element and a pointer to the previous element.

Safety

ptr must be a pointer to an object that is part of this list. prev must be a pointer to an object that is the previous object in this list (null for the head)

pub unsafe fn cursor_mut_from_ptr_and_prev(
    &mut self,
    ptr: *const <A::PointerOps as PointerOps>::Value,
    prev: *const <A::PointerOps as PointerOps>::Value
) -> CursorMut<'_, A>

Creates a CursorMut from a pointer to an element and a pointer to the previous element.

Safety

ptr must be a pointer to an object that is part of this list. prev must be a pointer to an object that is the previous object in this list (null for the head)

pub unsafe fn cursor_from_ptr_and_next(
    &self,
    ptr: *const <A::PointerOps as PointerOps>::Value,
    next: *const <A::PointerOps as PointerOps>::Value
) -> Cursor<'_, A>

Creates a Cursor from a pointer to an element and a pointer to the next element.

Safety

ptr must be a pointer to an object that is part of this list. next must be a pointer to an object that is the next object in this list (null for the tail)

pub unsafe fn cursor_mut_from_ptr_and_next(
    &mut self,
    ptr: *const <A::PointerOps as PointerOps>::Value,
    next: *const <A::PointerOps as PointerOps>::Value
) -> CursorMut<'_, A>

Creates a CursorMut from a pointer to an element and a pointer to the next element.

Safety

ptr must be a pointer to an object that is part of this list. next must be a pointer to an object that is the next object in this list (null for the tail)

pub fn front(&self) -> Cursor<'_, A>

Returns a Cursor pointing to the first element of the list. If the list is empty then a null cursor is returned.

pub fn front_mut(&mut self) -> CursorMut<'_, A>

Returns a CursorMut pointing to the first element of the list. If the the list is empty then a null cursor is returned.

pub fn back(&self) -> Cursor<'_, A>

Returns a Cursor pointing to the last element of the list. If the list is empty then a null cursor is returned.

pub fn back_mut(&mut self) -> CursorMut<'_, A>

Returns a CursorMut pointing to the last element of the list. If the list is empty then a null cursor is returned.

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

Gets an iterator over the objects in the XorLinkedList.

pub fn clear(&mut self)

Removes all elements from the XorLinkedList.

This will unlink all object currently in the list, which requires iterating through all elements in the XorLinkedList. Each element is converted back to an owned pointer and then dropped.

pub fn fast_clear(&mut self)

Empties the XorLinkedList without unlinking or freeing objects in it.

Since this does not unlink any objects, any attempts to link these objects into another XorLinkedList will fail but will not cause any memory unsafety. To unlink those objects manually, you must call the force_unlink function on them.

pub fn take(&mut self) -> XorLinkedList<A> where
    A: Clone, 

Takes all the elements out of the XorLinkedList, leaving it empty. The taken elements are returned as a new XorLinkedList.

pub fn push_front(&mut self, val: <A::PointerOps as PointerOps>::Pointer)

Inserts a new element at the start of the XorLinkedList.

pub fn push_back(&mut self, val: <A::PointerOps as PointerOps>::Pointer)

Inserts a new element at the end of the XorLinkedList.

pub fn pop_front(&mut self) -> Option<<A::PointerOps as PointerOps>::Pointer>

Removes the first element of the XorLinkedList.

This returns None if the XorLinkedList is empty.

pub fn pop_back(&mut self) -> Option<<A::PointerOps as PointerOps>::Pointer>

Removes the last element of the XorLinkedList.

This returns None if the XorLinkedList is empty.

pub fn reverse(&mut self)

Reverses the list in-place.

Due to the structure of XorLinkedList, this operation is O(1).

Trait Implementations

impl<A: Adapter> Debug for XorLinkedList<A> where
    A::LinkOps: XorLinkedListOps,
    <A::PointerOps as PointerOps>::Value: Debug, 

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

Formats the value using the given formatter.

impl<A: Adapter + Default> Default for XorLinkedList<A> where
    A::LinkOps: XorLinkedListOps, 

fn default() -> XorLinkedList<A>

Returns the “default value” for a type.

impl<A: Adapter> Drop for XorLinkedList<A> where
    A::LinkOps: XorLinkedListOps, 

fn drop(&mut self)

Executes the destructor for this type.

impl<A: Adapter> IntoIterator for XorLinkedList<A> where
    A::LinkOps: XorLinkedListOps, 

type Item = <A::PointerOps as PointerOps>::Pointer

The type of the elements being iterated over.

type IntoIter = IntoIter<A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<A>

Creates an iterator from a value.

impl<'a, A: Adapter + 'a> IntoIterator for &'a XorLinkedList<A> where
    A::LinkOps: XorLinkedListOps, 

type Item = &'a <A::PointerOps as PointerOps>::Value

The type of the elements being iterated over.

type IntoIter = Iter<'a, A>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<A: Adapter + Send> Send for XorLinkedList<A> where
    <A::PointerOps as PointerOps>::Pointer: Send,
    A::LinkOps: XorLinkedListOps, 

impl<A: Adapter + Sync> Sync for XorLinkedList<A> where
    <A::PointerOps as PointerOps>::Value: Sync,
    A::LinkOps: XorLinkedListOps,