Struct DoublyLinkedList 

pub struct DoublyLinkedList<T> { /* private fields */ }

Vec based doubly linked list implementation

Example

use lru_st::DoublyLinkedList;

let mut dll = DoublyLinkedList::new();
dll.push_front(42);
dll.push_front(43);

assert_eq!(dll.back(), Some(&42));
assert_eq!(dll.front(), Some(&43));

dll.push_back(44);
assert_eq!(dll.front(), Some(&43));
assert_eq!(dll.back(), Some(&44));

Implementations

impl<T> DoublyLinkedList<T>

pub fn new() -> Self

Creates a new empty DoublyLinkedList

pub fn with_capacity(capacity: usize) -> Self

Creates a new empty DoublyLinkedList with a given capacity

pub fn from_vec(v: Vec<T>) -> Self

Creates a new DoublyLinkedList from a Vec

pub fn is_empty(&self) -> bool

Returns true if the list is empty

pub fn push_front(&mut self, v: T) -> Cursor

Pushes an element to the front of the list

pub fn push_back(&mut self, v: T) -> Cursor

Pushes an element to the back of the list and returning the Cursor pointing to this element. The Cursor can then be used to directly access/move/pop element.

pub fn get(&self, c: Cursor) -> Option<&T>

Get the element in the list at a given Cursor or None if there is no element. If wanting to get an element at a given position see DoublyLinkedList::get_nth.

pub fn get_nth(&self, n: usize) -> Option<&T>

Get an element given its position in the list

pub fn get_mut(&mut self, c: Cursor) -> Option<&mut T>

Get a mutable element at a given position in the list or None if there is no element.

pub fn get_mut_nth(&mut self, n: usize) -> Option<&mut T>

Get an element given its position in the list

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

Get the element at the front of the list

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

Get a mutable reference to the element at the front of the list

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

Get the element a the back of the list

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

Get a mutable reference to the element at the back of the list

pub fn len(&self) -> usize

Returns the number of elements in the list

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

Pops the element a the back of the list

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

Provides an iterator (i.e. DoublyLinkedListIter) over the elements of the list

pub fn move_front(&mut self, at: Cursor) -> Result<(), Error>

Move item at cursor to the head of list

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

Pops the item at front of the doubly linked list

pub fn pop(&mut self, at: Cursor) -> Option<T>

Pops the item located at at Cursor in the doubly linked list. This API pops an element according to its Cursor which is not corresponding to its position within the linked list. To pop an item according to its position in the linked list use pop_nth.

pub fn pop_nth(&mut self, n: usize) -> Option<T>

Pops the nth element of linked list

Trait Implementations

impl<T> Debug for DoublyLinkedList<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for DoublyLinkedList<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Display for DoublyLinkedList<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> PartialEq for DoublyLinkedList<T>

where T: PartialEq,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.