Struct CircularList

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

A circular doubly linked list.

Implementations

impl<T> CircularList<T>

pub fn len(&self) -> usize

Gets the size of the list.

pub fn is_empty(&self) -> bool

Returns true if the list contains no element.

pub fn add(&mut self, val: T)

Adds an element to the end of the list.

Exemple

my_list.add("Hello");
assert_eq!(my_list.pop(), Some("Hello"))

pub fn peek(&self) -> &T

Returns a shared reference to the value of the list head.

Panic

Panics if the list is empty.

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

Removes the first element of the list and returns it if any.

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

Removes the last element of the list and returns it if any.

pub fn exchange(&mut self, i: usize, j: usize)

Exchanges the place of the element at position i and the element at position j. This operation has O(n) complexity. For a constant time swap operation, see double_cursor and DoubleCursor::swap.

pub fn append(&mut self, other: Self)

Assembles this list with another by putting all its elements at the end the list.

pub fn merge(&mut self, other: Self)

where T: PartialOrd,

Assembles this list with another by keeping the elements sorted. It is assumed that the 2 lists are sorted.

pub fn sort(&mut self)

where T: PartialOrd,

Sorts the list.

pub fn left_rot(&mut self, count: usize)

Moves the head count steps to the left.

Example

let mut yoda_says: CircularList<_> = "ready you are not ".chars().collect();
yoda_says.left_rot(6);
assert_eq!("you are not ready ", yoda_says.into_iter().collect::<String>())

pub fn rotate(&mut self, count: isize)

Rotate the head of the list count times to the left if count > 0 or -count times to the right if count < 0. Do nothing if count == 0.

pub fn rotate_until<F: Fn(&T) -> bool>(&mut self, f: F)

Rotate the head until the given condition is true. Do nothing on empty lists.

pub fn right_rot(&mut self, count: usize)

Moves the head count steps to the right.

Example

let mut yoda_says: CircularList<_> = "the greatest teacher failure is ".chars().collect();
yoda_says.right_rot(11);
assert_eq!("failure is the greatest teacher ", yoda_says.into_iter().collect::<String>())

pub fn iter_forever(&self) -> impl Iterator<Item = &T>

Returns an infinite iterator over the list except if it is empty, in which case the returned iterator is also empty.

pub fn iter(&self) -> impl Iterator<Item = &T>

Returns an iterator over the list.

pub fn iter_mut_forever(&mut self) -> impl Iterator<Item = &mut T>

Returns an infinite iterator that allows modifying each value. The returned iterator is empty if the list is empty.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Returns an iterator that allows modifying each value.

pub fn cursor(&self) -> Option<Cursor<'_, T>>

Returns some Cursor pointing to the first element of the list (if any).

pub fn cursor_mut(&mut self) -> Option<CursorMut<'_, T>>

Returns some CursorMut pointing to the first element of the list (if any).

pub fn double_cursor(&mut self) -> Option<DoubleCursor<'_, T>>

Returns some DoubleCursor where the ‘a’ and the ‘b’ parts are pointing both to the first element of the list (if any).

Trait Implementations

impl<T: Clone> Clone for CircularList<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CircularList<T>

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

Formats the value using the given formatter.

impl<T> Default for CircularList<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for CircularList<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> FromIterator<T> for CircularList<T>

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

Creates a value from an iterator.

impl<T> IntoIterator for CircularList<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.