Struct atlist_rs::LinkedList

pub struct LinkedList<T> { /* fields omitted */ }

A doubly-linked list in which the liftime of iterator is independent from self.

The LinkedList allows pushing and popping elements at either end in constant time.

Implementations

impl<T> LinkedList<T>

pub fn new() -> Self

Creates an empty LinkedList.

Examples

use atlist_rs::LinkedList;

let list: LinkedList<u32> = LinkedList::new();

pub fn len(&self) -> usize

Returns the length of the LinkedList.

This operation should compute in O(1) time.

Examples

use atlist_rs::LinkedList;

let mut dl = LinkedList::new();

let _ = dl.push_front(2);
assert_eq!(dl.len(), 1);

let _ = dl.push_front(1);
assert_eq!(dl.len(), 2);

let _ = dl.push_back(3);
assert_eq!(dl.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the LinkedList is empty.

This operation should compute in O(1) time.

Examples

use atlist_rs::LinkedList;

let mut dl = LinkedList::new();
assert!(dl.is_empty());

let _ = dl.push_front("foo");
assert!(!dl.is_empty());

pub fn clear(&mut self)

Removes all elements from the LinkedList.

This operation should compute in O(n) time.

Examples

use atlist_rs::{LinkedList, LinkedListError};

let mut dl = LinkedList::new();

dl.push_front(2);
dl.push_front(1);
assert_eq!(dl.len(), 2);
assert_eq!(*dl.front().unwrap(), 1);

dl.clear();
assert_eq!(dl.len(), 0);
assert_eq!(dl.front(), Err(LinkedListError::Empty));

pub fn iter(&self) -> Iter<T>

Provides a forward iterator.

Examples

use atlist_rs::LinkedList;

let mut list: LinkedList<u32> = LinkedList::new();

let _ = list.push_back(0);
let _ = list.push_back(1);
let _ = list.push_back(2);

let mut iter = list.iter();
assert_eq!(*iter.next().unwrap(), 0);
assert_eq!(*iter.next().unwrap(), 1);
assert_eq!(*iter.next().unwrap(), 2);
assert_eq!(iter.next(), None);

pub fn iter_mut(&mut self) -> IterMut<T>

Provides a forward iterator.

Examples

use atlist_rs::LinkedList;
use std::cell::RefCell;

let mut list: LinkedList<RefCell<u32>> = LinkedList::new();

let _ = list.push_back(RefCell::new(0));
let _ = list.push_back(RefCell::new(1));
let _ = list.push_back(RefCell::new(2));

for element in list.iter_mut() {
    *(*element).borrow_mut() += 10;
}

let mut iter = list.iter_mut();
assert_eq!(*(*iter.next().unwrap()).borrow(), 10);
assert_eq!(*(*iter.next().unwrap()).borrow(), 11);
assert_eq!(*(*iter.next().unwrap()).borrow(), 12);
assert_eq!(iter.next(), None);

pub fn iter_front(&self) -> Iter<T>

Provides a iterator at the front element.

The iterator is pointing to the “ghost” non-element if the list is empty.

pub fn iter_back(&self) -> Iter<T>

Provides a iterator at the back element.

The iterator is pointing to the “ghost” non-element if the list is empty.

pub fn iter_mut_front(&mut self) -> IterMut<T>

Provides a iterator with editing operations at the front element.

The iterator is pointing to the “ghost” non-element if the list is empty.

pub fn iter_mut_back(&mut self) -> IterMut<T>

Provides a iterator with editing operations at the back element.

The iterator is pointing to the “ghost” non-element if the list is empty.

pub fn push_front(&mut self, elt: T) -> LinkedListResult<()>

Adds an element first in the list.

This operation should compute in O(1) time.

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

Removes the first element and returns it, or None if the list is empty.

This operation should compute in O(1) time.

pub fn push_back(&mut self, elt: T) -> LinkedListResult<()>

Appends an element to the back of a list.

This operation should compute in O(1) time.

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

Removes the last element from a list and returns it, or None if it is empty.

This operation should compute in O(1) time.

pub fn front(&self) -> LinkedListResult<LinkedListItem<T>>

Provides a reference to the front element, or None if the list is empty.

Examples

use atlist_rs::{LinkedList, LinkedListError};

let mut dl = LinkedList::new();
assert_eq!(dl.front(), Err(LinkedListError::Empty));

let _ = dl.push_front(1);
assert_eq!(*dl.front().unwrap(), 1);

pub fn back(&self) -> LinkedListResult<LinkedListItem<T>>

Provides a reference to the back element, or None if the list is empty.

Examples

use atlist_rs::{LinkedList, LinkedListError};

let mut dl = LinkedList::new();
assert_eq!(dl.back(), Err(LinkedListError::Empty));

let _ = dl.push_back(1);
assert_eq!(*dl.back().unwrap(), 1);

pub fn contains_iter(&self, x: &Iter<T>) -> LinkedListResult<()>

Returns true if the LinkedList contains an element equal to the given value.

Examples

use atlist_rs::{LinkedList, LinkedListError};

let mut list: LinkedList<u32> = LinkedList::new();
let mut another_list: LinkedList<u32> = LinkedList::new();

let _ = list.push_back(0);
let _ = list.push_back(1);
let _ = another_list.push_back(2);

assert_eq!(list.contains_iter(&list.iter()), Ok(()));
assert_eq!(list.contains_iter(&another_list.iter()), Err(LinkedListError::IteratorNotInList));

pub fn contains_iter_mut(&self, x: &IterMut<T>) -> LinkedListResult<()>

Returns true if the LinkedList contains an element equal to the given value.

Examples

use atlist_rs::{LinkedList, LinkedListError};

let mut list: LinkedList<u32> = LinkedList::new();
let mut another_list: LinkedList<u32> = LinkedList::new();

let _ = list.push_back(0);
let _ = list.push_back(1);
let _ = another_list.push_back(2);

let iter = list.iter_mut();
let another_iter = another_list.iter_mut();
assert_eq!(list.contains_iter_mut(&iter), Ok(()));
assert_eq!(list.contains_iter_mut(&another_iter), Err(LinkedListError::IteratorNotInList));

pub fn insert_before(
    &mut self,
    iter: &IterMut<T>,
    elt: T
) -> LinkedListResult<IterMut<T>>

Inserts a new element into the LinkedList before the current one.

If the cursor is pointing at the “ghost” non-element then the new element is inserted at the end of the LinkedList.

Returns the iterator of inserted value if success, or error if failed

pub fn insert_after(
    &mut self,
    iter: &IterMut<T>,
    elt: T
) -> LinkedListResult<IterMut<T>>

Inserts a new element into the LinkedList after the current one.

If the cursor is pointing at the “ghost” non-element then the new element is inserted at the front of the LinkedList.

Returns the iterator of inserted value if success, or error if failed

pub fn remove_iter_mut(
    &mut self,
    iter: &mut IterMut<T>
) -> LinkedListResult<LinkedListItem<T>>

Removes the current iterator from the LinkedList.

The element that was removed is returned, the iterator will point to the “ghost” non-element.

If the iterator is currently pointing to the “ghost” non-element then no element is removed and Err(LinkedListError::IteratorNotInList) is returned.

Trait Implementations

impl<T: Clone> Clone for LinkedList<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for LinkedList<T>

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

Formats the value using the given formatter.

impl<T> Default for LinkedList<T>

fn default() -> Self

Creates an empty LinkedList<T>.

impl<T: Eq> Eq for LinkedList<T>

impl<'a, T: 'a + Copy> Extend<&'a T> for LinkedList<T>

fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> Extend<T> for LinkedList<T>

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> FromIterator<T> for LinkedList<T>

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

Creates a value from an iterator.

impl<T: Hash> Hash for LinkedList<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T> IntoIterator for &LinkedList<T>

type Item = LinkedListItem<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) -> Iter<T>

Creates an iterator from a value.

impl<T> IntoIterator for &mut LinkedList<T>

type Item = LinkedListItem<T>

The type of the elements being iterated over.

type IntoIter = IterMut<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<T>

Creates an iterator from a value.

impl<T: Ord> Ord for LinkedList<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<LinkedList<T>> for LinkedList<T>

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<LinkedList<T>> for LinkedList<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.