Struct ValueIndex

pub struct ValueIndex(pub u32);

A type safe wrapper over an index into the ValueVec.

Tuple Fields

0: u32

Implementations

impl ValueIndex

pub const INVALID: ValueIndex

The value index that is not considered to be valid.

Trait Implementations

impl Clone for ValueIndex

fn clone(&self) -> ValueIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueIndex

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

Formats the value using the given formatter.

impl Default for ValueIndex

The most sensible default for a value index is invalid.

fn default() -> Self

Returns the “default value” for a type.

impl DeserializeBytes for ValueIndex

fn deserialize(read_buf: impl Buf) -> Result<Self, SerializationError>

where Self: Sized,

impl Hash for ValueIndex

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 Index<ValueIndex> for ValueVec

type Output = Word

The returned type after indexing.

fn index(&self, index: ValueIndex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<ValueIndex> for ValueVec

fn index_mut(&mut self, index: ValueIndex) -> &mut Self::Output

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

impl Ord for ValueIndex

fn cmp(&self, other: &ValueIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ValueIndex

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ValueIndex

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl SerializeBytes for ValueIndex

fn serialize(&self, write_buf: impl BufMut) -> Result<(), SerializationError>

impl Copy for ValueIndex

impl Eq for ValueIndex

impl StructuralPartialEq for ValueIndex