Struct libspecr::List

pub struct List<T: Obj>(/* private fields */);

Garbage-collected Vec-like datastructure implementing Copy. Note that functions which seem to mutate the List, actually clone the list and allocate a new GcCow under the hood.

Implementations

impl<T: Obj> List<T>

pub fn iter(&self) -> ConsumingIter<T>

An ordered iterator over all elements of List.

impl<T: Obj> List<T>

pub fn new() -> Self

Returns an empty List.

pub fn len(&self) -> Int

Returns the number of elements in self.

pub fn is_empty(self) -> bool

Returns true if the list contains no elements.

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

Returns the first element of self or None if self is empty.

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

Returns the last element of self or None if self is empty.

pub fn mutate_at<O: Obj>(&mut self, i: Int, f: impl FnOnce(&mut T) -> O) -> O

Conceptually equivalent to f(&mut self[i]). Mutates the ith element by giving a mutable ref of it into the function f. The return value of f will be returned from mutate_at.

Instead of actual mutation, a new list is allocated, where only the ith element is changed. Then self is changed so that it points to that new list.

pub fn try_mutate_at<O: Obj, E>( &mut self, i: Int, f: impl FnOnce(&mut T) -> NdResult<O, E>, ) -> NdResult<O, E>

Like mutate_at, but the closure is fallible

pub fn get(&self, i: Int) -> Option<T>

Returns the ith element of the list.

pub fn set(&mut self, i: Int, t: T)

Sets the ith element of the list.

pub fn index_at(&self, i: impl Into<Int>) -> T

The indexing operator: specr translates a[b] to a.index_at(b).

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

Push an element to the end of the list.

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

Pop the element from the end of the list. Returns None is the list was empty.

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

Pop the element from the beginning of the list. Returns None is the list was empty.

pub fn reverse(&mut self)

Reverse the list.

pub fn subslice_with_length(&self, start: Int, length: Int) -> List<T>

Conceptually equivalent to self[start..length].

pub fn write_subslice_at_index(&mut self, start: Int, src: List<T>)

Conceptually equivalent to self[start..src.len()] = src;

pub fn sort_by_key<K: Obj + Ord>(&mut self, f: impl FnMut(T) -> K)

Sorts the list with a key extraction function.

pub fn zip<T2: Obj>(self, other: List<T2>) -> List<(T, T2)>

Combine two lists to a list of pairs.

pub fn any(self, f: impl FnMut(T) -> bool) -> bool

Tests if any element of the list matches a predicate.

pub fn all(self, f: impl FnMut(T) -> bool) -> bool

Tests if all elements of the list matches a predicate.

pub fn map<O: Obj>(self, f: impl FnMut(T) -> O) -> List<O>

applies f to each element of the list and returns the outputs as another list.

pub fn flat_map<O: Obj>(self, f: impl FnMut(T) -> List<O>) -> List<O>

Works like map, but flattens nested structure.

pub fn try_map<O: Obj, E>( self, f: impl FnMut(T) -> E, ) -> <<E as Try>::Residual as Residual<List<O>>>::TryType

where E: Try<Output = O>, <E as Try>::Residual: Residual<List<O>>,

Applies f to each element of the list and returns the successful outputs as another lists. If at least one call to f failed its error is returned instead.

Trait Implementations

impl<T: Clone + Obj> Clone for List<T>

fn clone(&self) -> List<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<A: Obj> FromIterator<A> for List<A>

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = A>,

Creates a value from an iterator.

impl<T: Hash + Obj> Hash for List<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Obj> IntoIterator for List<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = ConsumingIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

fn eq(&self, other: &List<T>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy + Obj> Copy for List<T>

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

impl<T: Obj> StructuralPartialEq for List<T>