Struct nth_cons_list::List

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

An immutable cons list.

Examples

A list can be created using nil and cons.

use nth_cons_list::{cons, nil};

// A list containing `1, 2, 3`
let list = cons(1, cons(2, cons(3, nil())));

Lists can be cheaply shared using .clone().

use std::fmt::Display;
use nth_cons_list::*;

fn print_list<A: Display>(list: List<A>) {
    println!("{}", list);
}

let list = cons(1, cons(2, cons(3, nil())));
print_list(list.clone());

Methods

impl<A> List<A>

fn head(&self) -> &A

Returns the first element of the list.

Panics

Panics if the list is empty.

fn tail(&self) -> List<A>

Returns a list containing all elements except the first.

Panics

Panics if the list is empty.

fn head_opt(&self) -> Option<&A>

Returns the first element of the list, or None if this list is empty.

fn tail_opt(&self) -> Option<List<A>>

Returns a list containing all elements except the first, or None if this list is empty.

fn is_empty(&self) -> bool

Tests whether this list is empty.

fn len(&self) -> usize

Returns the length of this list.

fn iter(&self) -> Iter<A>

Returns an iterator over the elements of this list.

fn reverse(&self) -> List<A> where
    A: Clone, 

Returns a list with the elements in reverse order.

fn from_double_ended_iter<I: DoubleEndedIterator<Item = A>>(iter: I) -> List<A>

Creates a new list from a DoubleEndedIterator.

Trait Implementations

impl<A> Clone for List<A>

fn clone(&self) -> Self

Clones the list by cloning a reference counted pointer to the list's contents; this operation is very cheap.

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

Performs copy-assignment from source.

impl<'a, A: 'a> IntoIterator for &'a List<A>

type Item = &'a A

The type of the elements being iterated over.

type IntoIter = Iter<'a, A>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<A> FromIterator<A> for List<A>

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

Creates a value from an iterator.

impl<A: Display> Display for List<A>

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

Formats the value using the given formatter.

impl<A: Debug> Debug for List<A>

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

Formats the value using the given formatter.

impl<A: PartialEq> PartialEq for List<A>

fn eq(&self, other: &List<A>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A: Eq> Eq for List<A>

impl<A: Hash> Hash for List<A>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<A: PartialOrd> PartialOrd for List<A>

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl<A: Ord> Ord for List<A>

fn cmp(&self, other: &List<A>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<A> Default for List<A>

fn default() -> Self

Returns the "default value" for a type.