Struct safe_index::examples::basic::VarMap

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

Vector indexed by variable indexes.

Methods

impl<T> VarMap<T>

pub fn of(vec: Vec<T>) -> Self

Creates an empty map from an existing one.

pub fn new() -> Self

Creates an empty map.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty map with some capacity.

pub fn len(&self) -> usize

Number of elements in the map.

pub fn capacity(&self) -> usize

Capacity of the map.

pub fn next_index(&self) -> VarIndex

The next free index (wrapped self.len()).

pub fn last_index(&self) -> Option<VarIndex>

The last index in the map.

pub fn push(&mut self, elem: T) -> VarIndex

Pushes an element.

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

Pops an element.

pub fn clear(&mut self)

Clears a map.

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

Iterates over the elements.

Important traits for VarMapIter<&'a VarMap<T>>

impl<'a, T: 'a> Iterator for VarMapIter<&'a VarMap<T>> type Item = (VarIndex, &'a T);impl<'a, T: 'a> Iterator for VarMapIter<IterMut<'a, T>> type Item = (VarIndex, &'a mut T);impl<T> Iterator for VarMapIter<VarMap<T>> type Item = (VarIndex, T);

pub fn index_iter<'a>(&'a self) -> VarMapIter<&'a VarMap<T>> where
    T: 'a, 

Iterates over the elements with the index.

Important traits for VarMapIter<&'a VarMap<T>>

impl<'a, T: 'a> Iterator for VarMapIter<&'a VarMap<T>> type Item = (VarIndex, &'a T);impl<'a, T: 'a> Iterator for VarMapIter<IterMut<'a, T>> type Item = (VarIndex, &'a mut T);impl<T> Iterator for VarMapIter<VarMap<T>> type Item = (VarIndex, T);

pub fn index_iter_mut<'a>(&'a mut self) -> VarMapIter<IterMut<'a, T>> where
    T: 'a, 

Iterates over the elements with the index, mutable version.

Important traits for VarMapIter<&'a VarMap<T>>

impl<'a, T: 'a> Iterator for VarMapIter<&'a VarMap<T>> type Item = (VarIndex, &'a T);impl<'a, T: 'a> Iterator for VarMapIter<IterMut<'a, T>> type Item = (VarIndex, &'a mut T);impl<T> Iterator for VarMapIter<VarMap<T>> type Item = (VarIndex, T);

pub fn into_index_iter(self) -> VarMapIter<VarMap<T>>

Iterates over the elements with the index.

pub fn iter_mut(&mut self) -> IterMut<T>

Iterates over the elements (mutable version).

pub fn shrink_to_fit(&mut self)

Shrinks the capacity as much as possible.

pub fn swap(&mut self, a: VarIndex, b: VarIndex)

Swap from Vec.

pub fn swap_remove(&mut self, idx: VarIndex) -> T

Swap remove from Vec.

impl<T: Clone> VarMap<T>

pub fn of_elems(elem: T, size: usize) -> Self

Creates an empty vector with some capacity.

Methods from Deref<Target = Vec<T>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl<T: Clone> Clone for VarMap<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq> PartialEq<VarMap<T>> for VarMap<T>

fn eq(&self, other: &Self) -> 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<T: PartialOrd> PartialOrd<VarMap<T>> for VarMap<T>

fn partial_cmp(&self, other: &VarMap<T>) -> Option<Ordering>

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

fn lt(&self, other: &VarMap<T>) -> bool

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

fn le(&self, other: &VarMap<T>) -> bool

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

fn gt(&self, other: &VarMap<T>) -> bool

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

fn ge(&self, other: &VarMap<T>) -> bool

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

impl<T: Eq> Eq for VarMap<T>

impl<T: Ord> Ord for VarMap<T>

fn cmp(&self, other: &VarMap<T>) -> 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<T> IntoIterator for VarMap<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a VarMap<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut VarMap<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, T>

Creates an iterator from a value.

impl<T> From<Vec<T>> for VarMap<T>

fn from(vec: Vec<T>) -> Self

Performs the conversion.

impl<T> Default for VarMap<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Debug> Debug for VarMap<T>

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

Formats the value using the given formatter.

impl<T> Deref for VarMap<T>

type Target = Vec<T>

The resulting type after dereferencing.

fn deref(&self) -> &Vec<T>

Dereferences the value.

impl<T> Index<VarIndex> for VarMap<T>

type Output = T

The returned type after indexing.

fn index(&self, index: VarIndex) -> &T

Performs the indexing (container[index]) operation.

impl<T> Index<Range<usize>> for VarMap<T>

type Output = [T]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeInclusive<usize>> for VarMap<T>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeFrom<usize>> for VarMap<T>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeTo<usize>> for VarMap<T>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> IndexMut<VarIndex> for VarMap<T>

fn index_mut(&mut self, index: VarIndex) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T> FromIterator<T> for VarMap<T>

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

Creates a value from an iterator.