Struct intrusive_collections::singly_linked_list::SinglyLinkedList

pub struct SinglyLinkedList<A: Adapter<Link=Link>> { /* fields omitted */ }

An intrusive singly-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<Link=Link>> SinglyLinkedList<A>

fn new(adapter: A) -> SinglyLinkedList<A>

Creates an empty SinglyLinkedList.

fn is_empty(&self) -> bool

Returns true if theSinglyLinkedList` is empty.

fn cursor(&self) -> Cursor<A>

Returns a null Cursor for this list.

fn cursor_mut(&mut self) -> CursorMut<A>

Returns a null CursorMut for this list.

unsafe fn cursor_from_ptr(&self, ptr: *const A::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.

unsafe fn cursor_mut_from_ptr(&mut self, ptr: *const A::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.

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.

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.

fn iter(&self) -> Iter<A>

Gets an iterator over the objects in the SinglyLinkedList.

fn clear(&mut self)

Removes all elements from the SinglyLinkedList.

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

fn fast_clear(&mut self)

Empties the SinglyLinkedList without unlinking or freeing objects in it.

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

fn take(&mut self) -> SinglyLinkedList<A> where A: Clone

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

fn push_front(&mut self, val: A::Pointer)

Inserts a new element at the start of the SinglyLinkedList.

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

Removes the first element of the SinglyLinkedList.

This returns None if the SinglyLinkedList is empty.

Trait Implementations

impl<A: Adapter<Link=Link> + Sync> Sync for SinglyLinkedList<A> where A::Value: Sync

impl<A: Adapter<Link=Link> + Send> Send for SinglyLinkedList<A> where A::Pointer: Send

impl<A: Adapter<Link=Link>> Drop for SinglyLinkedList<A>

fn drop(&mut self)

A method called when the value goes out of scope.

impl<A: Adapter<Link=Link>> IntoIterator for SinglyLinkedList<A>

type Item = A::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<Link=Link> + 'a> IntoIterator for &'a SinglyLinkedList<A>

type Item = &'a A::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<Link=Link> + Default> Default for SinglyLinkedList<A>

fn default() -> SinglyLinkedList<A>

Returns the "default value" for a type.

impl<A: Adapter<Link=Link>> Debug for SinglyLinkedList<A> where A::Value: Debug

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

Formats the value using the given formatter.