Struct PropertyKey 

pub struct PropertyKey(/* private fields */);

Implementations

impl PropertyKey

pub const fn index(index: u32) -> Option<PropertyKey>

An immediate index key, for index < 2^31.

pub fn atom(id: StringId) -> PropertyKey

The key of an atom. Panics if the atom index does not fit (callers allocate atoms below KEY_INDEX_LIMIT).

pub fn symbol(id: SymbolId) -> PropertyKey

pub const fn kind(self) -> KeyKind

pub const fn raw(self) -> u32

pub const fn from_raw(bits: u32) -> PropertyKey

The key whose raw bits are bits: an instruction’s imm field. Every bit pattern decodes to some key.

pub const fn to_value(self) -> Value

The key as a value: an Int32 for an index, else the string or symbol.

pub const fn heap_value(self) -> Option<Value>

The heap value the key keeps alive, if any.

Trait Implementations

impl Clone for PropertyKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PropertyKey

impl Debug for PropertyKey

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

Formats the value using the given formatter.

impl Eq for PropertyKey

impl Hash for PropertyKey

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

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for PropertyKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PropertyKey

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for PropertyKey