Enum bones_framework::prelude::piccolo::value::Value

pub enum Value<'gc> {
    Nil,
    Boolean(bool),
    Integer(i64),
    Number(f64),
    String(String<'gc>),
    Table(Table<'gc>),
    Function(Function<'gc>),
    Thread(Thread<'gc>),
    UserData(UserData<'gc>),
}

Variants

Nil

Boolean(bool)

Integer(i64)

Number(f64)

String(String<'gc>)

Table(Table<'gc>)

Function(Function<'gc>)

Thread(Thread<'gc>)

UserData(UserData<'gc>)

Implementations

impl<'gc> Value<'gc>

pub fn type_name(self) -> &'static str

pub fn display<W>(self, w: W) -> Result<(), Error>

where W: Write,

pub fn is_nil(self) -> bool

pub fn to_bool(self) -> bool

Lua nil and false are false, anything else is true.

pub fn not(self) -> Value<'gc>

pub fn to_number(self) -> Option<f64>

Interprets Numbers, Integers, and Strings as a Number, if possible.

pub fn to_integer(self) -> Option<i64>

Interprets Numbers, Integers, and Strings as an Integer, if possible.

pub fn to_constant(self) -> Option<Constant<String<'gc>>>

Trait Implementations

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

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

Returns a copy 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<(), Error>

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, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'gc, 'a, 'b, 'c> Extend<&'b Value<'gc>> for &'c mut Stack<'gc, 'a>

where 'gc: 'b,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = &'b Value<'gc>>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'gc, 'a, 'b> Extend<&'a Value<'gc>> for Stack<'gc, 'a>

where 'gc: 'b,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = &'a Value<'gc>>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'gc, 'a, 'b> Extend<Value<'gc>> for &'b mut Stack<'gc, 'a>

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Value<'gc>>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'gc, 'a> Extend<Value<'gc>> for Stack<'gc, 'a>

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Value<'gc>>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

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

fn from(v: Callback<'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, S> From<Constant<S>> for Value<'gc>

where String<'gc>: From<S>,

fn from(constant: Constant<S>) -> 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<String<'gc>> for Value<'gc>

fn from(v: String<'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<Thread<'gc>> for Value<'gc>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(error: Value<'gc>) -> LuaError<'gc>

Converts to this type from the input type.

impl<'gc, const N: usize> From<Value<'gc>> for MetaResult<'gc, N>

fn from(value: Value<'gc>) -> MetaResult<'gc, N>

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

fn from_value( _: Context<'gc>, value: Value<'gc>, ) -> Result<Value<'gc>, TypeError>

impl<'a, 'gc> IntoValue<'gc> for &'a Value<'gc>

fn into_value(self, ctx: Context<'gc>) -> Value<'gc>

impl<'gc> IntoValue<'gc> for Value<'gc>

fn into_value(self, _: Context<'gc>) -> Value<'gc>

impl<'gc> Stashable<'gc> for Value<'gc>

type Stashed = StaticValue

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

impl<'gc> ValueExt<'gc> for Value<'gc>

fn as_static_user_data<T>(&self) -> Result<&'gc T, TypeError>

where T: 'static,

Convert to a static user data type.

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