Struct toolshed::list::List

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

A single-ended linked list.

Methods

impl<'arena, T> List<'arena, T>

pub const fn empty() -> Self

Create a new empty List.

pub fn clear(&self)

Turns the list into an empty list.

Internally, all this method does is removing the reference to the first item on the list.

Important traits for ListIter<'arena, T>

impl<'arena, T> Iterator for ListIter<'arena, T> type Item = &'arena T;

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

Returns an iterator over the items in the list.

pub fn is_empty(&self) -> bool

Checks if the list is empty.

pub fn only_element(&self) -> Option<&'arena T>

Returns the first element if, and only if, the list contains just that single element.

pub fn first_element(&self) -> Option<&'arena T>

Returns the reference to the first element.

pub fn into_unsafe(self) -> UnsafeList

Returns an UnsafeList for the current List. While this function is safe itself, using UnsafeList might lead to undefined behavior.

impl<'arena, T: Copy> List<'arena, T>

pub fn from(arena: &'arena Arena, value: T) -> List<'arena, T>

Create a single-element list from the given value.

pub fn from_iter<I>(arena: &'arena Arena, source: I) -> List<'arena, T> where
    I: IntoIterator<Item = T>, 

Create a list from an iterator of items.

pub fn prepend(&self, arena: &'arena Arena, value: T) -> &'arena T

Adds a new element to the beginning of the list.

pub fn shift(&self) -> Option<&'arena T>

Removes the first element from the list and returns it.

pub fn shift_ref(&mut self) -> Option<&'arena T>

Get the first element of the List, if any, then create a new List starting from the second element at the reference to the old list.

Note: This does not modify the internal state of the List. If you wish to modify the list use shift instead.

Trait Implementations

impl<'a, 'b, A, B> PartialEq<List<'b, B>> for List<'a, A> where
    A: PartialEq<B>, 

fn eq(&self, other: &List<'b, B>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'arena, T: Copy> Copy for List<'arena, T>

impl<'arena, T: Clone> Clone for List<'arena, T>

fn clone(&self) -> List<'arena, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'arena, T> IntoIterator for List<'arena, T>

type Item = &'arena T

The type of the elements being iterated over.

type IntoIter = ListIter<'arena, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = &'arena T

The type of the elements being iterated over.

type IntoIter = ListIter<'arena, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'arena, T> Debug for List<'arena, T> where
    T: Debug, 

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

Formats the value using the given formatter.