Enum muse_lang::runtime::value::Value

pub enum Value {
    Primitive(Primitive),
    Symbol(SymbolRef),
    Dynamic(AnyDynamic),
}

A Muse virtual machine value.

Variants

Primitive(Primitive)

Symbol(SymbolRef)

A symbol.

Dynamic(AnyDynamic)

A dynamically allocated, garbage collected type.

Implementations

impl Value

pub const TRUE: Self = _

pub const FALSE: Self = _

pub const NIL: Self = _

pub const ZERO: Self = _

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

Returns this value with any garbage collected values upgraded to root references.

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, guard: &CollectionGuard<'_>) -> 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, guard: &CollectionGuard<'_>) -> 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<'guard, T>( &self, guard: &'guard CollectionGuard<'_>, ) -> Option<&'guard 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.

pub fn call( &self, vm: &mut VmContext<'_, '_>, arity: impl Into<Arity>, ) -> Result<Value, Fault>

Invokes this value as a function.

pub fn invoke( &self, vm: &mut VmContext<'_, '_>, name: &SymbolRef, arity: impl Into<Arity>, ) -> Result<Value, Fault>

Invokes name on this value.

pub fn add( &self, vm: &mut VmContext<'_, '_>, rhs: &Self, ) -> Result<Value, Fault>

Adds self to rhs.

pub fn sub( &self, vm: &mut VmContext<'_, '_>, rhs: &Self, ) -> Result<Value, Fault>

Subtracts rhs from self.

pub fn mul( &self, vm: &mut VmContext<'_, '_>, rhs: &Self, ) -> Result<Value, Fault>

Multiplies self by rhs.

pub fn pow( &self, vm: &mut VmContext<'_, '_>, exp: &Self, ) -> Result<Value, Fault>

Raises self to the rhs power.

pub fn div( &self, vm: &mut VmContext<'_, '_>, rhs: &Self, ) -> Result<Value, Fault>

Divides self by rhs.

pub fn idiv( &self, vm: &mut VmContext<'_, '_>, rhs: &Self, ) -> Result<Value, Fault>

Divides self by rhs, using whole numbers.

pub fn rem( &self, vm: &mut VmContext<'_, '_>, rhs: &Self, ) -> Result<Value, Fault>

Calcualtes the remainder of dividing self by rhs using whole numbers.

pub fn not(&self, vm: &mut VmContext<'_, '_>) -> Result<Self, Fault>

Returns the inverse of Self::truthy.

pub fn negate(&self, vm: &mut VmContext<'_, '_>) -> Result<Self, Fault>

Negates this value.

pub fn bitwise_not(&self, vm: &mut VmContext<'_, '_>) -> Result<Self, Fault>

Returns the bitwise not of this value.

pub fn bitwise_and( &self, vm: &mut VmContext<'_, '_>, rhs: &Value, ) -> Result<Self, Fault>

Returns the bitwise and of self and rhs.

pub fn bitwise_or( &self, vm: &mut VmContext<'_, '_>, rhs: &Value, ) -> Result<Self, Fault>

Returns the bitwise or of self and rhs.

pub fn bitwise_xor( &self, vm: &mut VmContext<'_, '_>, rhs: &Value, ) -> Result<Self, Fault>

Returns the bitwise xor of self and rhs.

pub fn shift_left( &self, vm: &mut VmContext<'_, '_>, rhs: &Value, ) -> Result<Self, Fault>

Returns the bitwise shift left of self by rhs.

pub fn shift_right( &self, vm: &mut VmContext<'_, '_>, rhs: &Value, ) -> Result<Self, Fault>

Returns the shift right of self by rhs.

pub fn to_string(&self, vm: &mut VmContext<'_, '_>) -> Result<SymbolRef, Fault>

Returns this value as a shared string reference.

pub fn map_str<R>( &self, vm: &mut VmContext<'_, '_>, map: impl FnOnce(&mut VmContext<'_, '_>, &str) -> R, ) -> Result<R, Fault>

Maps the contents of this value as a str, if possible.

pub fn hash_into(&self, vm: &mut VmContext<'_, '_>, hasher: &mut ValueHasher)

Hashes this value into hasher.

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

Calculates the hash of this value.

pub fn equals( &self, vm: ContextOrGuard<'_, '_, '_>, other: &Self, ) -> Result<bool, Fault>

Returns true if self and other are equivalent values.

pub fn matches( &self, vm: &mut VmContext<'_, '_>, other: &Self, ) -> Result<bool, Fault>

Returns true if self matches other.

pub fn total_cmp( &self, vm: &mut VmContext<'_, '_>, other: &Self, ) -> Result<Ordering, Fault>

Returns an ordering of self and other that takes into account both the type of data and the value itself.

pub fn take(&mut self) -> Value

Take the contents of this value, leaving nil behind.

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

Perform a deep-clone on the contents of this value.

Not all types are able to be deeply cloned. Unsupported types will result in None.

pub fn format(&self, context: &mut VmContext<'_, '_>, f: impl Write) -> Result

Formats this value for display into f.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl From<&Symbol> for Value

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<Symbol> for Value

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 Value

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for Value

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Value

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for Value

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Value

fn from(value: u8) -> Self

Converts to this type from the input type.

impl FromIterator<Value> for List

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for Value

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 Trace for Value

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

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 Value

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 Value

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 Value

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.

impl Copy for Value