Enum Value 

pub enum Value<'gc> {
    Null,
    Bool(bool),
    Int(i64),
    Float(f64),
    Str(Str<'gc>),
    Table(Table<'gc>),
    Function(Function<'gc>),
    UserData(AnyUserData<'gc>),
    Error(GcError<'gc>),
}

Enum of all lucia values.

Variants

Null

null - A null value.

Bool(bool)

bool - A true / false value.

Int(i64)

int - A 64-bit integer.

Float(f64)

float - A 64-bit floating point number.

Str(Str<'gc>)

str - A UTF-8 string.

Table(Table<'gc>)

table - A table.

Function(Function<'gc>)

function - A function.

UserData(AnyUserData<'gc>)

userdata - An UserData.

Error(GcError<'gc>)

error - An error.

Implementations

impl<'gc> Value<'gc>

pub fn metatable(&self) -> Option<Table<'gc>>

pub fn id(&self) -> Option<NonZeroUsize>

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

pub const fn value_type(self) -> ValueType

pub fn is_null(self) -> bool

pub fn repr(&self) -> String

Trait Implementations

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

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

Returns a duplicate of the value.

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

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

Formats the value using the given formatter.

impl<'gc> Default for Value<'gc>

fn default() -> Value<'gc>

Returns the “default value” for a type.

impl<'gc> Display for Value<'gc>

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

Formats the value using the given formatter.

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

fn from(v: AnyCallback<'gc>) -> Value<'gc>

Converts to this type from the input type.

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

fn from(v: Closure<'gc>) -> Value<'gc>

Converts to this type from the input type.

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

fn from(v: Function<'gc>) -> Value<'gc>

Converts to this type from the input type.

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

fn from(v: Str<'gc>) -> Value<'gc>

Converts to this type from the input type.

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

fn from(v: Table<'gc>) -> Value<'gc>

Converts to this type from the input type.

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

fn from(value: Value<'gc>) -> Self

Converts to this type from the input type.

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

fn from(value: Value<'_>) -> Self

Converts to this type from the input type.

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

fn from(v: bool) -> Value<'gc>

Converts to this type from the input type.

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

fn from(v: f64) -> Value<'gc>

Converts to this type from the input type.

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

fn from(v: i64) -> Value<'gc>

Converts to this type from the input type.

impl<'gc> FromIterator<Value<'gc>> for TableEntries<'gc>

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

Creates a value from an iterator.

impl<'gc> FromValue<'gc> for Value<'gc>

fn from_value(value: Value<'gc>) -> Result<Self, Error<'gc>>

impl<'gc> Hash for Value<'gc>

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

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

type Stashed = StaticValue

fn stash(self, roots: &DynamicRootSet<'gc>, mc: &Mutation<'gc>) -> Self::Stashed

impl<'gc> Copy for Value<'gc>

impl<'gc> Eq for Value<'gc>