Struct safe_index::examples::basic::VarIndex

pub struct VarIndex { /* fields omitted */ }

Index of a variable.

Methods

impl VarIndex

pub fn new(val: usize) -> Self

Wraps an int.

pub fn zero() -> Self

Zero.

pub fn one() -> Self

One.

pub fn get(&self) -> usize

Accessor.

pub fn inc(&mut self)

Increments the int.

pub fn dec(&mut self)

Decrements the int.

impl VarIndex

Important traits for VarRange

impl Iterator for VarRange type Item = VarIndex;

pub fn up_to(self, end: VarIndex) -> VarRange

Creates a range between two indexes (upper bound is exclusive).

Trait Implementations

impl Eq for VarIndex

impl Into<usize> for VarIndex

fn into(self) -> usize

Performs the conversion.

impl<'a> Into<usize> for &'a VarIndex

fn into(self) -> usize

Performs the conversion.

impl Clone for VarIndex

fn clone(&self) -> VarIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<VarIndex> for VarIndex

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<usize> for VarIndex

fn partial_cmp(&self, int: &usize) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 PartialEq<VarIndex> for VarIndex

fn eq(&self, other: &VarIndex) -> bool

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

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

This method tests for !=.

impl PartialEq<usize> for VarIndex

fn eq(&self, int: &usize) -> 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 Ord for VarIndex

fn cmp(&self, other: &VarIndex) -> 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.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl From<usize> for VarIndex

fn from(val: usize) -> Self

Performs the conversion.

impl<'a> From<&'a usize> for VarIndex

fn from(val: &'a usize) -> Self

Performs the conversion.

impl Copy for VarIndex

impl Deref for VarIndex

type Target = usize

The resulting type after dereferencing.

fn deref(&self) -> &usize

Dereferences the value.

impl Hash for VarIndex

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<T: Into<usize>> Add<T> for VarIndex

type Output = VarIndex

The resulting type after applying the + operator.

fn add(self, rhs: T) -> VarIndex

Performs the + operation.

impl<T: Into<usize>> AddAssign<T> for VarIndex

fn add_assign(&mut self, rhs: T)

Performs the += operation.

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> IndexMut<VarIndex> for VarMap<T>

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

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

impl Display for VarIndex

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

Formats the value using the given formatter.

impl Debug for VarIndex

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

Formats the value using the given formatter.