Struct muse_lang::runtime::symbol::SymbolRef

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

A garbage-collected weak reference to a Symbol.

Implementations

impl SymbolRef

pub fn load<'guard>( &self, guard: &'guard CollectionGuard<'_>, ) -> Option<&'guard str>

Loads the underlying string value of this symbol.

Returns None if the underlying symbol has been freed by the garbage collector.

pub fn try_load<'guard>( &self, guard: &'guard CollectionGuard<'_>, ) -> Result<&'guard str, ValueFreed>

Tries to loads the underlying string value of this symbol.

Errors

Returns ValueFreed if the underlying symbol has been freed by the garbage collector.

pub fn upgrade(&self, guard: &CollectionGuard<'_>) -> Option<Symbol>

Upgrades this weak reference to a reference-counted Symbol.

Returns None if the underlying symbol has been freed by the garbage collector.

pub fn try_upgrade( &self, guard: &CollectionGuard<'_>, ) -> Result<Symbol, ValueFreed>

Tries to upgrade this weak reference to a reference-counted Symbol.

Errors

Returns ValueFreed if the underlying symbol has been freed by the garbage collector.

Trait Implementations

impl Clone for SymbolRef

fn clone(&self) -> SymbolRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolRef

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

Formats the value using the given formatter.

impl<'a> From<&'a StaticSymbol> for SymbolRef

fn from(value: &'a StaticSymbol) -> Self

Converts to this type from the input type.

impl From<&String> for SymbolRef

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&Symbol> for SymbolRef

fn from(value: &Symbol) -> Self

Converts to this type from the input type.

impl From<&SymbolRef> for SymbolRef

fn from(value: &SymbolRef) -> Self

Converts to this type from the input type.

impl From<&SymbolRef> for Value

fn from(value: &SymbolRef) -> Self

Converts to this type from the input type.

impl From<&str> for SymbolRef

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for SymbolRef

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Symbol> for SymbolRef

fn from(value: Symbol) -> Self

Converts to this type from the input type.

impl From<SymbolRef> for Value

fn from(value: SymbolRef) -> Self

Converts to this type from the input type.

impl From<bool> for SymbolRef

fn from(bool: bool) -> Self

Converts to this type from the input type.

impl Hash for SymbolRef

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 SymbolRef

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

Restrict a value to a certain interval.

impl PartialEq<Symbol> for SymbolRef

fn eq(&self, other: &Symbol) -> 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 PartialEq<SymbolRef> for Symbol

fn eq(&self, other: &SymbolRef) -> 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 PartialEq for SymbolRef

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

fn partial_cmp(&self, other: &SymbolRef) -> 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 Sort<SymbolRef> for Symbol

fn compare(&self, other: &SymbolRef) -> Ordering

Compare self and other, returning the comparison result.

impl Trace for SymbolRef

const MAY_CONTAIN_REFERENCES: bool = true

If true, this type may contain references and should have its trace() function invoked during the collector’s “mark” phase.

fn trace(&self, tracer: &mut Tracer<'_>)

Traces all refrences that this value references.

impl Copy for SymbolRef

impl Eq for SymbolRef

impl StructuralPartialEq for SymbolRef