Struct pill_core::PillSlotMapKeyData

pub struct PillSlotMapKeyData {
    pub index: u32,
    pub version: NonZeroU32,
}

Fields

index: u32

version: NonZeroU32

Implementations

impl PillSlotMapKeyData

fn new(index: u32, version: u32) -> Self

fn null() -> Self

fn is_null(self) -> bool

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 PillSlotMapKeyData

fn clone(&self) -> PillSlotMapKeyData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PillSlotMapKeyData

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

Formats the value using the given formatter.

impl Default for PillSlotMapKeyData

fn default() -> Self

Returns the “default value” for a type.

impl Hash for PillSlotMapKeyData

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 PillSlotMapKeyData

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

Restrict a value to a certain interval.

impl PartialEq<PillSlotMapKeyData> for PillSlotMapKeyData

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

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

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

This method tests for !=.

impl PartialOrd<PillSlotMapKeyData> for PillSlotMapKeyData

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

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

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

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

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

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

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

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

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 Copy for PillSlotMapKeyData

impl Eq for PillSlotMapKeyData

impl StructuralEq for PillSlotMapKeyData

impl StructuralPartialEq for PillSlotMapKeyData