Struct linear_sim::object::Key

pub struct Key(_);

A VecMap index

Methods

impl Key

pub const fn from_raw(key: KeyType) -> Self

⚠ Note: does not check against KEY_MAX

pub const fn value(&self) -> KeyType

pub const fn index(&self) -> usize

Trait Implementations

impl Eq for Key

impl PartialEq<Key> for Key

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

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

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

This method tests for !=.

impl From<u32> for Key

fn from(key: KeyType) -> Self

Debug panic if key greater or equal to KEY_MAX

impl From<usize> for Key

fn from(key: usize) -> Self

Debug panic if key greater or equal to KEY_MAX

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Key

fn cmp(&self, other: &Key) -> 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 Copy for Key

impl PartialOrd<Key> for Key

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

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

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

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

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

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

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

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

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

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

impl Deref for Key

type Target = KeyType

The resulting type after dereferencing.

fn deref(&self) -> &KeyType

Dereferences the value.

impl Debug for Key

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

Formats the value using the given formatter.