Struct functional_list::List

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

A singly linked list. Implemented using functional algorithms, with no mutation.

Implementations

impl<T> List<T>

pub fn single(v: T) -> Self

Returns a list consisting of a single element

pub const fn nil() -> Self

Returns an empty list

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

Returns the first element in the list, or if it is empty, returns None

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

Returns every element in the list except for the first. If the list has <= 1 elements, returns None.

pub fn tail_ref(&self) -> Option<List<&T>>

Returns every element in the list except for the first, as a list of references.

pub fn is_empty(&self) -> bool

Returns true if the list is empty

pub fn len(&self) -> usize

Returns the number of elements in the list

pub fn take(&self, n: usize) -> List<&T>

Returns the first n elements of the list.

pub fn take_while(&self, f: impl FnMut(&T) -> bool) -> List<&T>

Returns the first continuous list of elements that match the condition.

pub fn cons(head: T, tail: Self) -> Self

Returns a new list with head as its first element, and tail as the rest of the list.

pub fn prepend(&self, value: T) -> Self

Equivalent to List::cons(value, (*self).clone())

pub fn for_each<'s>(&'s self, f: impl FnMut(&'s T))

Iterate through the elements of the list

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

Returns an iterator through the elements of the list.

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

Returns a list of references to this list's elements.

pub fn fold<'s, R>(&'s self, initial: R, f: impl FnMut(R, &'s T) -> R) -> R

pub fn reduce<'s>(
    &'s self,
    f: impl FnMut(Option<&'s T>, &'s T) -> Option<&'s T>
) -> Option<&'s T>

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

Returns a list of references to this list's elements in reverse order

pub fn append<'a>(&'a self, other: &'a Self) -> List<&'a T>

Append the other list to the end of this list, returning a list of references to both lists' elements.

pub fn map<R>(&self, f: impl Fn(&T) -> R) -> List<R>

Build a new list by applying the passed function to each of the list's elements.

pub fn zip<'a, U>(&'a self, other: &'a List<U>) -> List<(&'a T, &'a U)>

Zip two lists together, forming a list of key-value pairs.

impl<T: Clone> List<T>

pub fn reversed(&self) -> Self

Returns a reversed clone of this list. Equivalent to self.rev().cloned().

impl<'v, T: Clone> List<&'v T>

pub fn cloned(self) -> List<T>

Clones the elements of the list from the references.

impl<T> List<List<T>>

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

Concatenate the inner lists to form a single list.

impl<K, V> List<(K, V)> where
    K: Eq, 

pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&V> where
    K: Borrow<Q>,
    Q: Eq, 

Get the element that matches the key, if it exists. Searches the elements in order.

pub fn insert(&self, key: K, value: V) -> Self

Equivalent to self.prepend((key, value))

Trait Implementations

impl<T> Clone for List<T>

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for List<T>

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

Formats the value using the given formatter.

impl<T> Default for List<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T: Eq + PartialEq> Eq for List<T>

impl<T: Clone> FromIterator<T> for List<T>

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

Creates a value from an iterator.

impl<T: PartialEq> PartialEq<List<T>> for List<T>

pub 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 !=.