Enum Value

pub enum Value<'gc, C: CustomTypes<S>, S: System<C>> {
    Bool(bool),
    Number(Number),
    Text(Text),
    Image(Rc<Image>),
    Audio(Rc<Audio>),
    Native(Rc<C::NativeValue>),
    List(Gc<'gc, RefLock<VecDeque<Value<'gc, C, S>>>>),
    Closure(Gc<'gc, RefLock<Closure<'gc, C, S>>>),
    Entity(Gc<'gc, RefLock<Entity<'gc, C, S>>>),
}

Any primitive value.

Variants

Bool(bool)

A primitive boolean value.

Number(Number)

A primitive numeric value. Snap! and NetsBlox use 64-bit floating point values for all numbers.

Text(Text)

A primitive text value, which is an immutable reference type.

Image(Rc<Image>)

An image stored as a binary buffer.

Audio(Rc<Audio>)

An audio clip stored as as a binary buffer.

Native(Rc<C::NativeValue>)

A reference to a native object handle produced by System.

List(Gc<'gc, RefLock<VecDeque<Value<'gc, C, S>>>>)

A primitive list type, which is a mutable reference type.

Closure(Gc<'gc, RefLock<Closure<'gc, C, S>>>)

A closure/lambda function. This contains information about the closure’s bytecode location, parameters, and captures from the parent scope.

Entity(Gc<'gc, RefLock<Entity<'gc, C, S>>>)

A reference to an Entity in the environment.

Implementations

impl<'gc, C: CustomTypes<S>, S: System<C>> Value<'gc, C, S>

pub fn to_simple(&self) -> Result<SimpleValue, ToSimpleError<C, S>>

Converts this Value into a SimpleValue for use outside the VM.

pub fn from_simple(mc: &Mutation<'gc>, value: SimpleValue) -> Self

Converts a SimpleValue into a Value for use inside the VM.

Examples found in repository

examples/basic.rs (line 70)

    fn from_intermediate<'gc>(mc: &Mutation<'gc>, value: Self::Intermediate) -> Value<'gc, C, StdSystem<C>> {
        Value::from_simple(mc, value)
    }

pub fn identity(&self) -> Identity<'gc, C, S>

Returns a value representing this object that implements Eq such that two values are equal if and only if they are references to the same object. This is primarily useful for testing for reference equality of lists.

pub fn as_bool(&self) -> Result<bool, ConversionError<C, S>>

Attempts to interpret this value as a bool.

pub fn as_number(&self) -> Result<Number, ConversionError<C, S>>

Attempts to interpret this value as a number.

pub fn as_text(&self) -> Result<Text, ConversionError<C, S>>

Attempts to interpret this value as a string.

pub fn as_image(&self) -> Result<&Rc<Image>, ConversionError<C, S>>

Attempts to interpret this value as an image.

pub fn as_audio(&self) -> Result<&Rc<Audio>, ConversionError<C, S>>

Attempts to interpret this value as an audio clip.

pub fn as_list( &self, ) -> Result<Gc<'gc, RefLock<VecDeque<Value<'gc, C, S>>>>, ConversionError<C, S>>

Attempts to interpret this value as a list.

pub fn as_closure( &self, ) -> Result<Gc<'gc, RefLock<Closure<'gc, C, S>>>, ConversionError<C, S>>

Attempts to interpret this value as a closure.

pub fn as_entity( &self, ) -> Result<Gc<'gc, RefLock<Entity<'gc, C, S>>>, ConversionError<C, S>>

Attempts to interpret this value as an entity.

Trait Implementations

impl<'gc, C: CustomTypes<S>, S: System<C>> Clone for Value<'gc, C, S>

where bool: Clone, Number: Clone, Text: Clone, Rc<Image>: Clone, Rc<Audio>: Clone, Rc<C::NativeValue>: Clone, Gc<'gc, RefLock<VecDeque<Value<'gc, C, S>>>>: Clone, Gc<'gc, RefLock<Closure<'gc, C, S>>>: Clone, Gc<'gc, RefLock<Entity<'gc, C, S>>>: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'gc, C: CustomTypes<S>, S: System<C>> Collect for Value<'gc, C, S>

where bool: 'static, Number: 'static, Text: 'static, Rc<Image>: 'static, Rc<Audio>: 'static, Rc<C::NativeValue>: 'static,

fn needs_trace() -> bool

As an optimization, if this type can never hold a Gc pointer and trace is unnecessary to call, you may implement this method and return false. The default implementation returns true, signaling that Collect::trace must be called.

fn trace(&self, cc: &Collection)

Must call Collect::trace on all held Gc pointers. If this type holds inner types that implement Collect, a valid implementation would simply call Collect::trace on all the held values to ensure this.

impl<C: CustomTypes<S>, S: System<C>> Debug for Value<'_, C, S>

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

Formats the value using the given formatter.

impl<C: CustomTypes<S>, S: System<C>> Display for Value<'_, C, S>

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

Formats the value using the given formatter.

impl<'gc, C: CustomTypes<S>, S: System<C>> From<CheckedFloat<f64, NumberChecker>> for Value<'gc, C, S>

fn from(v: Number) -> Self

Converts to this type from the input type.

impl<'gc, C: CustomTypes<S>, S: System<C>> From<Gc<'gc, RefLock<Closure<'gc, C, S>>>> for Value<'gc, C, S>

fn from(v: Gc<'gc, RefLock<Closure<'gc, C, S>>>) -> Self

Converts to this type from the input type.

impl<'gc, C: CustomTypes<S>, S: System<C>> From<Gc<'gc, RefLock<Entity<'gc, C, S>>>> for Value<'gc, C, S>

fn from(v: Gc<'gc, RefLock<Entity<'gc, C, S>>>) -> Self

Converts to this type from the input type.

impl<'gc, C: CustomTypes<S>, S: System<C>> From<Gc<'gc, RefLock<VecDeque<Value<'gc, C, S>>>>> for Value<'gc, C, S>

fn from(v: Gc<'gc, RefLock<VecDeque<Value<'gc, C, S>>>>) -> Self

Converts to this type from the input type.

impl<'gc, C: CustomTypes<S>, S: System<C>> From<OurString<RcBytes, INLINE_SIZE>> for Value<'gc, C, S>

fn from(v: Text) -> Self

Converts to this type from the input type.

impl<'gc, C: CustomTypes<S>, S: System<C>> From<bool> for Value<'gc, C, S>

fn from(v: bool) -> Self

Converts to this type from the input type.

impl<'gc, C: CustomTypes<S>, S: System<C>> GetType for Value<'gc, C, S>

type Output = Type<C, S>

fn get_type(&self) -> Self::Output

Gets the type of value that is stored.