Struct slotmap::KeyData

pub struct KeyData { /* fields omitted */ }

The actual data stored in a Key.

This implements Ord so keys can be stored in e.g. BTreeMap, but the order of keys is unspecified.

Methods

impl KeyData

pub fn as_ffi(self) -> u64

Returns the key data as a 64-bit integer. No guarantees about its value are made other than that passing it to from_ffi will return a key equal to the original.

With this you can easily pass slot map keys as opaque handles to foreign code. After you get them back you can confidently use them in your slot map without worrying about unsafe behavior as you would with passing and receiving back references or pointers.

This is not a substitute for proper serialization, use serde for that. If you are not doing FFI, you almost surely do not need this function.

pub fn from_ffi(value: u64) -> Self

Iff value is a value received from k.as_ffi(), returns a key equal to k. Otherwise the behavior is safe but unspecified.

Trait Implementations

impl Clone for KeyData

fn clone(&self) -> KeyData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeyData

impl Debug for KeyData

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

Formats the value using the given formatter.

impl Default for KeyData

fn default() -> Self

Returns the "default value" for a type.

impl Eq for KeyData

impl From<DefaultKey> for KeyData

fn from(k: DefaultKey) -> Self

Performs the conversion.

impl From<KeyData> for DefaultKey

fn from(k: KeyData) -> Self

Performs the conversion.

impl Hash for KeyData

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 Ord for KeyData

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<KeyData> for KeyData

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

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

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

This method tests for !=.

impl PartialOrd<KeyData> for KeyData

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for KeyData

impl StructuralPartialEq for KeyData