Struct cons_rs::immutable::List

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

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

Implementations

impl<T> List<T>

pub const fn new() -> List<T>

Creates a new List.

Examples

use cons_rs::immutable::List;
 
let list: List<i32> = List::new();

pub fn prepend(&self, element: T) -> List<T>

Prepends a given element to the list, returning a copy of the list with the added element.

Examples

use cons_rs::immutable::List;
 
let list = List::new().prepend(1);

assert_eq!(list.head(), Some(&1));

pub fn tail(&self) -> List<T>

Returns a copy of the list with the first element removed.

Examples

use cons_rs::immutable::List;
 
let list = List::new().prepend(1);
assert_eq!(list.tail().head(), None);

let list = List::new().prepend(1).prepend(2);
assert_eq!(list.tail().head(), Some(&1));

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

Returns a reference to the first element in the list, if it exists.

Examples

use cons_rs::immutable::List;
 
let list = List::new().prepend(1);

assert_eq!(list.head(), Some(&1));

pub fn len(&self) -> usize

Returns the length of the list.

Examples

use cons_rs::immutable::List;
 
let list = List::new();
assert_eq!(list.len(), 0);

let list = list.prepend(3);
assert_eq!(list.len(), 1);

pub fn is_empty(&self) -> bool

Checks if the list is empty.

Examples

use cons_rs::immutable::List;
 
let list = List::new();
assert!(list.is_empty());

let list = list.prepend(1);
assert!(!list.is_empty());

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

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

Examples

use cons_rs::immutable::List;
 
let list = List::new().prepend(1).prepend(2);

let mut iter = list.iter();

assert_eq!(iter.next(), Some(&2));
assert_eq!(iter.next(), Some(&1));
assert_eq!(iter.next(), None);

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Default for List<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for List<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> IntoIterator for &'a List<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.