Struct index_list::IndexList

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

Implementations

impl<T> IndexList<T>

pub fn new() -> Self

Creates a new empty index list.

pub fn capacity(&self) -> usize

Returns the current capacity of the list.

pub fn len(&self) -> usize

Returns the number of valid elements in the list.

pub fn clear(&mut self)

Clears the list be removing all elements, making it empty.

pub fn is_empty(&self) -> bool

Returns true when the list is empty.

pub fn is_index_used(&self, index: Index) -> bool

Returns true if the index is valid.

pub fn first_index(&self) -> Index

Returns the index of the first element.

pub fn last_index(&self) -> Index

Returns the index of the last element.

pub fn next_index(&self, index: Index) -> Index

Returns the index of the next element, after index.

pub fn prev_index(&self, index: Index) -> Index

Returns the index of the previous element, before index.

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

Get a reference to the first element.

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

Get a reference to the last element.

pub fn get(&self, index: Index) -> Option<&T>

Get a reference to the element at the index.

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

Get a mutable reference to the first element.

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

Get a mutable reference to the last element.

pub fn get_mut(&mut self, index: Index) -> Option<&mut T>

Get a mutable reference to the element at the index.

pub fn peek_next(&self, index: Index) -> Option<&T>

Peek at next element, after index.

pub fn peek_prev(&self, index: Index) -> Option<&T>

Peek at previous element, before index.

pub fn contains(&self, elem: T) -> bool where
    T: PartialEq, 

Returns true if the element exists.

pub fn insert_first(&mut self, elem: T) -> Index

Insert a new element at the beginning.

pub fn insert_last(&mut self, elem: T) -> Index

Insert a new element at the end.

pub fn insert_before(&mut self, index: Index, elem: T) -> Index

Insert a new element before the index.

pub fn insert_after(&mut self, index: Index, elem: T) -> Index

Insert a new element after the index.

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

Remove the first element.

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

Remove the last element.

pub fn remove(&mut self, index: Index) -> Option<T>

Remove the element at the index.

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

Create a new iterator over all the element.

pub fn to_vec(&self) -> Vec<&T>

Create a vector for all elements.

pub fn from(vec: &mut Vec<T>) -> IndexList<T>

Insert all the elements from the vector, which will be drained.

pub fn trim_safe(&mut self)

Remove any unused indexes at the end by truncating.

pub fn trim_swap(&mut self)

Remove all unused elements by swapping indexes and then truncating. Note that this call may invalidate some indexes.

pub fn append(&mut self, other: &mut IndexList<T>)

Add the elements of the other list at the end.

pub fn prepend(&mut self, other: &mut IndexList<T>)

Add the elements of the other list at the beginning.

pub fn split(&mut self, index: Index) -> IndexList<T>

Split the list by moving the elements from the index to a new list.

Trait Implementations

impl<T: Debug> Debug for IndexList<T>

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

Formats the value using the given formatter.

impl<T> Default for IndexList<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Display for IndexList<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> From<T> for IndexList<T>

fn from(elem: T) -> IndexList<T>

Performs the conversion.