Struct lists::linked::doubly::DoublyLinkedList

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

A two-directional linked list, known more commonly as a DoublyLinkedList.

Implementations

impl<T> DoublyLinkedList<T>

pub const fn new() -> Self

Constructs a new, empty, DoublyLinkedList.

pub const fn len(&self) -> usize

Returns the len or the number of Nodes within the DoublyLinkedList.

Example

let list = dl_list![1, 2, 3];
 
assert_eq!(list.len(), 3);

pub const fn is_empty(&self) -> bool

Returns a bool that determines if the list is empty.

Example

let mut list = DoublyLinkedList::<i32>::new();
 
assert_eq!(list.is_empty(), true);
 
list.push_back(1);
assert_eq!(list.is_empty(), false);

pub fn clear(&mut self)

Clears the DoublyLinkedList settings its fields back to their default values.

Example

let mut list = dl_list![1, 2, 3, 4, 5];
list.clear();
 
assert_eq!(list, DoublyLinkedList::<i32>::new());

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

Returns a reference to the Node at the front of the DoublyLinkedList, also known as the head. Time complexity is O(1).

Example

let list = dl_list![2, 4, 0];
 
assert_eq!(list.front(), Some(&2));

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

Returns a reference to the Node at the back of the DoublyLinkedList, also known as the tail. Time complexity is O(1).

Example

let list = dl_list![2, 4, 0];
 
assert_eq!(list.back(), Some(&0));

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

Returns a mutable reference to the Node at the front of the DoublyLinkedList, also known as the head. Time complexity is O(1).

Example

let mut list = dl_list![2, 4, 0];
 
assert_eq!(list.front_mut(), Some(&mut 2));

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

Returns a mutable reference to the Node at the back of the DoublyLinkedList, also known as the tail. Time complexity is O(1).

Example

let mut list = dl_list![2, 4, 0];
 
assert_eq!(list.back_mut(), Some(&mut 0));

pub fn push_front(&mut self, value: T)

Pushes or prepends a new Node to the front of the DoublyLinkedList. Time complexity is O(1).

Example

let mut list = DoublyLinkedList::new();
 
list.push_front(1);
list.push_front(2);
list.push_front(3);
 
assert_eq!(list, dl_list![3, 2, 1]);

pub fn push_back(&mut self, value: T)

Pushes or appends a new Node to the back of the DoublyLinkedList. Time complexity is O(1).

Example

let mut list = DoublyLinkedList::new();
 
list.push_back(1);
list.push_back(2);
list.push_back(3);
 
assert_eq!(list, dl_list![1, 2, 3]);

pub fn get(&self, index: usize) -> Option<&T>

Returns a reference to the Node at the given index. Time complexity is O(n).

Example

let list = dl_list![1, 2, 3];
 
assert_eq!(list.get(1), Some(&2));

pub fn get_mut(&mut self, index: usize) -> Option<&mut T>

Returns a mutable reference to the Node at the given index. Time complexity is O(n).

Example

let mut list = dl_list![1, 2, 3];
 
assert_eq!(list.get_mut(1), Some(&mut 2));

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

Removes the list’s head Node, returning its value. Time complexity is O(1).

Example

let mut list = dl_list![1, 2, 3];
let pop = list.pop_front();
 
assert_eq!(pop, Some(1));
assert_eq!(list, dl_list![2, 3]);

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

Removes the list’s tail Node, returning its value. Time complexity is O(1).

Example

let mut list = dl_list![1, 2, 3];
let pop = list.pop_back();
 
assert_eq!(pop, Some(3));
assert_eq!(list, dl_list![1, 2]);

pub fn remove_front(&mut self)

Removes the list’s head Node. Time complexity is O(1).

Example

let mut list = dl_list![1, 2, 3];
list.remove_front();
 
assert_eq!(list, dl_list![2, 3]);

pub fn remove_back(&mut self)

Removes the list’s tail Node. Time complexity is O(1).

Example

let mut list = dl_list![1, 2, 3];
list.remove_back();
 
assert_eq!(list, dl_list![1, 2]);

Trait Implementations

impl<T> Clone for DoublyLinkedList<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for DoublyLinkedList<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for DoublyLinkedList<T>

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

Formats the value using the given formatter.

impl<T> FromIterator<T> for DoublyLinkedList<T>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> Index<usize> for DoublyLinkedList<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for DoublyLinkedList<T>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> IntoIterator for DoublyLinkedList<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = Iter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq<DoublyLinkedList<T>> for DoublyLinkedList<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T> Copy for DoublyLinkedList<T>

impl<T: Eq> Eq for DoublyLinkedList<T>