Enum muse_lang::runtime::value::RootedValue

pub enum RootedValue {
    Primitive(Primitive),
    Symbol(Symbol),
    Dynamic(AnyDynamicRoot),
}

A Muse virtual machine value that holds strong references.

Variants

Primitive(Primitive)

Symbol(Symbol)

A symbol.

Dynamic(AnyDynamicRoot)

A dynamically allocated, garbage collected type.

Implementations

impl RootedValue

pub const TRUE: Self = _

pub const FALSE: Self = _

pub const NIL: Self = _

pub const ZERO: Self = _

pub fn downgrade(&self) -> Value

Returns this value with weak references to any garbage collected data.

pub fn dynamic<'guard, T>( value: T, guard: &impl AsRef<CollectionGuard<'guard>>, ) -> Self

where T: DynamicValue + Trace,

Moves value into the virtual machine.

pub const fn is_nil(&self) -> bool

Returns true if this value is nil.

pub fn as_primitive(&self) -> Option<Primitive>

Returns this value as an i64, if possible.

pub fn as_i64(&self) -> Option<i64>

Returns this value as an i64, if possible.

pub fn as_u64(&self) -> Option<u64>

Returns this value as an u64, if possible.

pub fn as_u32(&self) -> Option<u32>

Returns this value as an u32, if possible.

pub fn as_u16(&self) -> Option<u16>

Returns this value as an u16, if possible.

pub fn as_usize(&self) -> Option<usize>

Returns this value as an usize, if possible.

pub fn as_f64(&self) -> Option<f64>

Returns this value as an f64, if possible.

pub fn to_i64(&self) -> Option<i64>

Converts this value to an i64, if possible.

pub fn to_u64(&self) -> Option<u64>

Converts this value to an u64, if possible.

pub fn to_u32(&self) -> Option<u32>

Converts this value to an u32, if possible.

pub fn to_usize(&self) -> Option<usize>

Converts this value to an usize, if possible.

pub fn to_f64(&self) -> Option<f64>

Converts this value to an f64, if possible.

pub fn as_symbol_ref(&self) -> Option<SymbolRef>

Returns this value as a SymbolRef, if possible.

pub fn as_symbol(&self) -> Option<&Symbol>

Returns this value as a Symbol, if possible.

pub fn as_any_dynamic(&self) -> Option<AnyDynamic>

Returns this value as an AnyDynamic, if possible.

pub fn as_dynamic<T>(&self) -> Option<Dynamic<T>>

where T: DynamicValue + Trace,

Returns this value as a Dynamic<T>, if this value contains a T.

pub fn as_rooted<T>(&self) -> Option<Rooted<T>>

where T: DynamicValue + Trace,

Returns this value as a Rooted<T>, if this value contains a T.

pub fn as_downcast_ref<T>(&self) -> Option<&T>

where T: DynamicValue + Trace,

Returns this value as a&T, if this value contains a T.

pub fn truthy(&self, vm: &mut VmContext<'_, '_>) -> bool

Returns true if this value should be considered true in a boolean expression.

Trait Implementations

impl Clone for RootedValue

fn clone(&self) -> RootedValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RootedValue

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

Formats the value using the given formatter.

impl Default for RootedValue

fn default() -> Self

Returns the “default value” for a type.

impl From<&Symbol> for RootedValue

fn from(value: &Symbol) -> Self

Converts to this type from the input type.

impl From<Symbol> for RootedValue

fn from(value: Symbol) -> Self

Converts to this type from the input type.

impl From<bool> for RootedValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for RootedValue

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for RootedValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for RootedValue

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for RootedValue

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for RootedValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for RootedValue

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for RootedValue

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for RootedValue

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for RootedValue

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for RootedValue

fn from(value: u8) -> Self

Converts to this type from the input type.

impl PartialEq for RootedValue

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 TryFrom<i128> for RootedValue

type Error = Fault

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for RootedValue

type Error = Fault

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u128> for RootedValue

type Error = Fault

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for RootedValue

type Error = Fault

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.