Struct Key 

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

A reference-counted handle to a keyed object.

This is the primary way objects reference each other in the Plasma engine. A null key (None) represents a nil reference.

Implementations

impl Key

pub fn null() -> Self

Create a null (nil) key.

pub fn from_uoid(uoid: Uoid) -> Self

Create a key from a Uoid (no file position).

pub fn from_uoid_with_pos(uoid: Uoid, start_pos: u32, data_len: u32) -> Self

Create a key with file position info (for demand loading).

pub fn is_null(&self) -> bool

Returns true if this is a null (nil) key.

pub fn is_some(&self) -> bool

Returns true if this key is non-null.

pub fn inner(&self) -> Option<&Arc<RwLock<KeyData>>>

Get the inner Arc for this key. Returns None for null keys.

pub fn uoid(&self) -> Uoid

Get the Uoid of this key. Panics on null keys.

pub fn name(&self) -> String

Get the name of the referenced object. Panics on null keys.

pub fn class_type(&self) -> u16

Get the class type of the referenced object. Panics on null keys.

pub fn try_name(&self) -> Option<String>

Try to get the name, returning None for null keys.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Self

Returns the “default value” for a type.

impl Display for Key

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

Formats the value using the given formatter.

impl Hash for Key

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 Key

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.

impl PartialEq for Key

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

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 Eq for Key