Struct intrusive_collections::linked_list::LinkedList

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

An intrusive doubly-linked list.

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

Methods

impl<A: Adapter> LinkedList<A> where
    A::LinkOps: LinkedListOps, 

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

Creates an empty LinkedList.

pub fn is_empty(&self) -> bool

Returns true if the LinkedList 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(
    &self,
    ptr: *const <A::PointerOps as PointerOps>::Value
) -> Cursor<A>

Creates a Cursor from a pointer to an element.

Safety

ptr must be a pointer to an object that is part of this list.

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

Creates a CursorMut from a pointer to an element.

Safety

ptr must be a pointer to an object that is part of this list.

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 LinkedList.

pub fn clear(&mut self)

Removes all elements from the LinkedList.

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

pub fn fast_clear(&mut self)

Empties the LinkedList without unlinking or freeing objects in it.

Since this does not unlink any objects, any attempts to link these objects into another LinkedList 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) -> LinkedList<A> where
    A: Clone, 

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

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

Inserts a new element at the start of the LinkedList.

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

Inserts a new element at the end of the LinkedList.

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

Removes the first element of the LinkedList.

This returns None if the LinkedList is empty.

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

Removes the last element of the LinkedList.

This returns None if the LinkedList is empty.

Trait Implementations

impl<A: Adapter> Debug for LinkedList<A> where
    A::LinkOps: LinkedListOps,
    <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 LinkedList<A> where
    A::LinkOps: LinkedListOps, 

fn default() -> LinkedList<A>

Returns the "default value" for a type.

impl<A: Adapter> Drop for LinkedList<A> where
    A::LinkOps: LinkedListOps, 

fn drop(&mut self)

Executes the destructor for this type.

impl<A: Adapter> IntoIterator for LinkedList<A> where
    A::LinkOps: LinkedListOps, 

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 LinkedList<A> where
    A::LinkOps: LinkedListOps, 

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 LinkedList<A> where
    <A::PointerOps as PointerOps>::Pointer: Send,
    A::LinkOps: LinkedListOps, 

impl<A: Adapter + Sync> Sync for LinkedList<A> where
    <A::PointerOps as PointerOps>::Value: Sync,
    A::LinkOps: LinkedListOps,