Struct cons_rs::List

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

A singly linked list. See the crate-level documentation for more.

Implementations

impl<T> List<T>

pub fn new() -> Self

Creates an empty List.

pub fn push(&mut self, element: T)

Prepends an element to the beginning of the List.

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

Removes the element at the front of the List, and returns it.

pub fn is_empty(&self) -> bool

Checks if the List is empty.

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

Returns an immutable reference to the value at the head of the List, if it exists.

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

Returns a mutable reference to the value at the head of the List, if it exists.

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

Creates an iterator that yields immutable references to all the elements in the List.

To get mutable references, see iter_mut.

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

Creates an iterator that yields mutable references to all the elements in the List.

To get immutable references, see iter.

Trait Implementations

impl<T: Default> Default for List<T>

fn default() -> List<T>

Returns the “default value” for a type.

impl<T> Drop for List<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> FromIterator<T> for List<T>

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

Creates a List from an Iterator.

Note that the order of elements is REVERSED. This is subject to change in the future.

use cons_rs::List;

let mut list: List<i32> = vec![1, 2]::collect();

assert_eq!(list.pop(), Some(2));
assert_eq!(list.pop(), Some(1));
assert_eq!(list.pop(), None);

impl<T> IntoIterator for List<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.