Enum Value

pub enum Value<'gc> {
    Number(f64),
    Boolean(bool),
    String(InternedString<'gc>),
    IoString(Gc<'gc, String>),
    Closure(Gc<'gc, Closure<'gc>>),
    NativeFunction(NativeFn<'gc>),
    List(GcRefLock<'gc, List<'gc>>),
    Object(GcRefLock<'gc, Object<'gc>>),
    Enum(GcRefLock<'gc, Enum<'gc>>),
    EnumVariant(Gc<'gc, EnumVariant<'gc>>),
    Class(GcRefLock<'gc, Class<'gc>>),
    Instance(GcRefLock<'gc, Instance<'gc>>),
    BoundMethod(Gc<'gc, BoundMethod<'gc>>),
    Module(InternedString<'gc>),
    Agent(Gc<'gc, Agent<'gc>>),
    Nil,
}

Variants

Number(f64)

Boolean(bool)

String(InternedString<'gc>)

IoString(Gc<'gc, String>)

Closure(Gc<'gc, Closure<'gc>>)

NativeFunction(NativeFn<'gc>)

List(GcRefLock<'gc, List<'gc>>)

Object(GcRefLock<'gc, Object<'gc>>)

Enum(GcRefLock<'gc, Enum<'gc>>)

EnumVariant(Gc<'gc, EnumVariant<'gc>>)

Class(GcRefLock<'gc, Class<'gc>>)

Instance(GcRefLock<'gc, Instance<'gc>>)

BoundMethod(Gc<'gc, BoundMethod<'gc>>)

Module(InternedString<'gc>)

Agent(Gc<'gc, Agent<'gc>>)

Nil

Implementations

impl<'gc> Value<'gc>

pub fn array(mc: &Mutation<'gc>, data: Vec<Value<'gc>>) -> Self

pub fn equals(&self, other: &Value<'gc>) -> bool

pub fn as_number(self) -> Result<f64, VmError>

pub fn as_boolean(&self) -> bool

pub fn as_string(self) -> Result<InternedString<'gc>, VmError>

pub fn as_string_value(&self) -> Result<StringValue<'gc>, VmError>

pub fn new_string(ctx: Context<'gc>, s: &str, should_intern: bool) -> Value<'gc>

pub fn as_closure(self) -> Result<Gc<'gc, Closure<'gc>>, VmError>

pub fn as_array(self) -> Result<GcRefLock<'gc, List<'gc>>, VmError>

pub fn as_agent(self) -> Result<Gc<'gc, Agent<'gc>>, VmError>

pub fn as_class(self) -> Result<GcRefLock<'gc, Class<'gc>>, VmError>

pub fn is_error(&self) -> bool

pub fn is_object(&self) -> bool

pub fn is_bound_method(&self) -> bool

pub fn is_class(&self) -> bool

pub fn is_instance(&self) -> bool

pub fn is_closure(&self) -> bool

pub fn is_native_function(&self) -> bool

pub fn is_nil(&self) -> bool

pub fn is_number(&self) -> bool

pub fn is_boolean(&self) -> bool

pub fn is_true(&self) -> bool

pub fn is_falsy(&self) -> bool

pub fn from_serde_value(ctx: Context<'gc>, value: &Value) -> Value<'gc>

pub fn to_serde_value(&self) -> Value

impl Value<'_>

pub fn is_enum(&self) -> bool

pub fn is_enum_variant(&self) -> bool

Trait Implementations

impl<'gc> Clone for Value<'gc>

fn clone(&self) -> Value<'gc>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'gc> Collect for Value<'gc>

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<'gc> Default for Value<'gc>

fn default() -> Value<'gc>

Returns the “default value” for a type.

impl Display for Value<'_>

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

Formats the value using the given formatter.

impl<'gc> From<Gc<'gc, Agent<'gc>>> for Value<'gc>

fn from(value: Gc<'gc, Agent<'gc>>) -> Self

Converts to this type from the input type.

impl<'gc> From<Gc<'gc, BoundMethod<'gc>>> for Value<'gc>

fn from(value: Gc<'gc, BoundMethod<'gc>>) -> Self

Converts to this type from the input type.

impl<'gc> From<Gc<'gc, Closure<'gc>>> for Value<'gc>

fn from(value: Gc<'gc, Closure<'gc>>) -> Self

Converts to this type from the input type.

impl<'gc> From<Gc<'gc, RefLock<Class<'gc>>>> for Value<'gc>

fn from(value: GcRefLock<'gc, Class<'gc>>) -> Self

Converts to this type from the input type.

impl<'gc> From<Gc<'gc, RefLock<Instance<'gc>>>> for Value<'gc>

fn from(value: GcRefLock<'gc, Instance<'gc>>) -> Self

Converts to this type from the input type.

impl<'gc> From<Gc<'gc, String>> for Value<'gc>

fn from(value: Gc<'gc, String>) -> Self

Converts to this type from the input type.

impl<'gc> From<Value<'gc>> for ReturnValue

fn from(value: Value<'gc>) -> 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<f64> for Value<'_>

fn from(value: f64) -> 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 PartialEq for Value<'_>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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<'gc> Copy for Value<'gc>