Struct generational_cache::collections::list::LinkedList

pub struct LinkedList<V, T> { /* private fields */ }

A double-linked linked list implementation using a generational Arena for allocation.

Implementations

impl<V, T> LinkedList<V, T>where V: Vector<Entry<Node<T>>>,

pub fn with_backing_vector(vector: V) -> Self

Creates a new LinkedList with given the backing Vector for the underlying Arena.

pub fn clear(&mut self) -> Result<(), ListError<V::Error>>

Removes all elements from this LinkedList.

pub fn reserve(&mut self, additional: usize) -> Result<(), ListError<V::Error>>

Reserves memory for the give number of additional elements in this LinkedList.

pub fn capacity(&self) -> usize

Returns the number of elements this LinkedList is capable of storing.

Since this LinkedList uses an Arena for allocation, it’s capacity is subject to the capacity of the underlying Arena.

pub fn len(&self) -> usize

Returns the number of elements stored in this LinkedList.

pub fn is_empty(&self) -> bool

Returns whether this LinkedList is empty.

pub fn get_mut(&mut self, link: &Link) -> Option<&mut T>

Returns a mutable reference to the element stored in the Node at the given Link.

pub fn get(&self, link: &Link) -> Option<&T>

Returns an imutable reference to the element stored in the Node at the given Link.

pub fn push_front(&mut self, value: T) -> Result<Link, ListError<V::Error>>

Pushes the given element to the front of this LinkedList.

pub fn push_back(&mut self, value: T) -> Result<Link, ListError<V::Error>>

Pushes the given element to the back of this LinkedList.

pub fn peek_front(&self) -> Option<&T>

Peeks the element at the front of this list.

pub fn peek_back(&self) -> Option<&T>

Peeks the element at the back of this list.

pub fn remove(&mut self, link: &Link) -> Option<T>

Removes the element referenced by the given link.

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

Removes the element at the front of this list.

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

Removes the element at the back of this list.

pub fn shift_push_front(&mut self, link: &Link) -> Option<()>

Shifts the element at the given Link to the front of this list.

pub fn shift_push_back(&mut self, link: &Link) -> Option<()>

Shifts the element at the given Link to the back of this list.

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

Returns an iterator to iterate over the elements in this list.

Trait Implementations

impl<V, T> Default for LinkedList<V, T>where V: Default + Vector<Entry<Node<T>>>,

fn default() -> Self

Returns the “default value” for a type.

impl<'a, V, T> IntoIterator for &'a LinkedList<V, T>where V: Vector<Entry<Node<T>>>,

type Item = (&'a Link, &'a T)

The type of the elements being iterated over.

type IntoIter = Iter<'a, V, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.