Enum Value 

pub enum Value {
    Nil,
    Boolean(bool),
    Integer(Integer),
    Number(Number),
    String(LuaString),
    Table(Table),
    Function(Function),
    LightUserData(LightUserData),
    UserData(AnyUserData),
    Thread(Thread),
    Vector(Vector),
    Buffer(Buffer),
    Error(Box<Error>),
}

A dynamically typed Lua value.

Mirrors mlua::Value. Reference-typed variants (Value::String, Value::Table, Value::Function) carry handles that keep both the value and the VM alive.

Variants

Nil

nil.

Boolean(bool)

A boolean.

Integer(Integer)

An integer (an f64 that is an exact, in-range whole number).

Number(Number)

A floating-point number.

String(LuaString)

A string.

Table(Table)

A table.

Function(Function)

A function (Lua or Rust).

LightUserData(LightUserData)

A raw-pointer light userdata. Mirrors mlua::Value::LightUserData.

UserData(AnyUserData)

A userdata value with typed Rust-side borrowing.

Thread(Thread)

A thread (coroutine).

Vector(Vector)

A Luau vector (3 f32 components). Mirrors mlua::Value::Vector.

Buffer(Buffer)

A Luau buffer (mutable, fixed-size byte array). Mirrors mlua::Value::Buffer.

Error(Box<Error>)

A boxed Lua/Rust error carried as a first-class value (mirrors mlua::Value::Error). Produced when a Rust error is returned to Lua.

Implementations

impl Value

pub const NIL: Value = Value::Nil

Value::Nil. Mirrors mlua::Nil.

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

The Lua type name of this value (e.g. "nil", "number", "table").

pub fn is_error(&self) -> bool

Whether this is an error value.

pub fn as_error(&self) -> Option<&Error>

View as a reference to the contained error, if any.

pub fn is_nil(&self) -> bool

Whether this is nil.

pub fn is_boolean(&self) -> bool

Whether this is a boolean.

pub fn is_number(&self) -> bool

Whether this is a number of either subtype.

pub fn is_integer(&self) -> bool

Whether this is the integer subtype.

pub fn is_string(&self) -> bool

Whether this is a string.

pub fn is_table(&self) -> bool

Whether this is a table.

pub fn is_function(&self) -> bool

Whether this is a function.

pub fn as_boolean(&self) -> Option<bool>

Lua truthiness: everything except nil and false is truthy.

pub fn as_integer(&self) -> Option<Integer>

View as an integer if it is one.

pub fn as_number(&self) -> Option<Number>

View as an f64 if it is a number of either subtype.

pub fn as_string(&self) -> Option<&LuaString>

View as a string handle.

pub fn as_table(&self) -> Option<&Table>

View as a table handle.

pub fn as_function(&self) -> Option<&Function>

View as a function handle.

pub fn is_userdata(&self) -> bool

Whether this is a userdata value.

pub fn as_userdata(&self) -> Option<&AnyUserData>

View as a userdata handle.

pub fn is_thread(&self) -> bool

Whether this is a thread (coroutine) value.

pub fn as_thread(&self) -> Option<&Thread>

View as a thread handle.

pub fn is_vector(&self) -> bool

Whether this is a Luau vector value. Mirrors mlua::Value::is_vector.

pub fn as_vector(&self) -> Option<&Vector>

View as a vector. Mirrors mlua::Value::as_vector.

pub fn is_buffer(&self) -> bool

Whether this is a Luau buffer value. Mirrors mlua::Value::is_buffer.

pub fn as_buffer(&self) -> Option<&Buffer>

View as a buffer handle. Mirrors mlua::Value::as_buffer.

pub fn as_i32(&self) -> Option<i32>

View as an i32 if it is an in-range integer.

pub fn as_u32(&self) -> Option<u32>

View as a u32 if it is an in-range integer.

pub fn as_i64(&self) -> Option<i64>

View as an i64 if it is an integer.

pub fn as_u64(&self) -> Option<u64>

View as a u64 if it is an in-range integer.

pub fn as_isize(&self) -> Option<isize>

View as an isize if it is an in-range integer.

pub fn as_usize(&self) -> Option<usize>

View as a usize if it is an in-range integer.

pub fn as_f32(&self) -> Option<f32>

View as an f32.

pub fn as_f64(&self) -> Option<f64>

View as an f64.

pub fn to_pointer(&self) -> *const c_void

A raw pointer identifying reference-typed values (tables, functions, strings, userdata). Returns null for value-typed (nil/bool/number) values. Mirrors mlua::Value::to_pointer.

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

Compare two values for equality honoring __eq metamethods. Mirrors mlua::Value::equals.

pub fn to_string(&self) -> Result<String>

The metatable-aware string form of this value (honors __tostring). Mirrors mlua::Value::to_string.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate 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 FromIterator<Value> for MultiValue

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

Creates a value from an iterator.

impl FromLua for Value

fn from_lua(value: Value, _lua: &Lua) -> Result<Self>

Perform the conversion.

fn from_lua_arg( arg: Value, _i: usize, _to: Option<&str>, lua: &Lua, ) -> Result<Self>

Convert an argument at 1-based position i. The default forwards to FromLua::from_lua; specific impls can produce nicer messages. Mirrors mlua::FromLua::from_lua_arg.

impl IntoLua for Value

fn into_lua(self, _lua: &Lua) -> Result<Value>

Perform the conversion.

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.