Enum mlua::Value [−][src]
pub enum Value<'lua> {
Nil,
Boolean(bool),
LightUserData(LightUserData),
Integer(Integer),
Number(Number),
String(String<'lua>),
Table(Table<'lua>),
Function(Function<'lua>),
Thread(Thread<'lua>),
UserData(AnyUserData<'lua>),
Error(Error),
}
Expand description
A dynamically typed Lua value. The String
, Table
, Function
, Thread
, and UserData
variants contain handle types into the internal Lua state. It is a logic error to mix handle
types between separate Lua
instances, and doing so will result in a panic.
Variants
Nil
The Lua value nil
.
Boolean(bool)
Tuple Fields
0: bool
The Lua value true
or false
.
LightUserData(LightUserData)
Tuple Fields
A “light userdata” object, equivalent to a raw pointer.
Integer(Integer)
Tuple Fields
0: Integer
An integer number.
Any Lua number convertible to a Integer
will be represented as this variant.
Number(Number)
Tuple Fields
0: Number
A floating point number.
String(String<'lua>)
Tuple Fields
0: String<'lua>
An interned string, managed by Lua.
Unlike Rust strings, Lua strings may not be valid UTF-8.
Table(Table<'lua>)
Tuple Fields
0: Table<'lua>
Reference to a Lua table.
Function(Function<'lua>)
Tuple Fields
0: Function<'lua>
Reference to a Lua function (or closure).
Thread(Thread<'lua>)
Tuple Fields
0: Thread<'lua>
Reference to a Lua thread (or coroutine).
UserData(AnyUserData<'lua>)
Tuple Fields
0: AnyUserData<'lua>
Reference to a userdata object that holds a custom type which implements UserData
.
Special builtin userdata types will be represented as other Value
variants.
Error(Error)
Tuple Fields
0: Error
Error
is a special builtin userdata type. When received from Lua it is implicitly cloned.
Implementations
Compares two values for equality.
Equality comparisons do not convert strings to numbers or vice versa. Tables, Functions, Threads, and Userdata are compared by reference: two objects are considered equal only if they are the same object.
If Tables or Userdata have __eq
metamethod then mlua will try to invoke it.
The first value is checked first. If that value does not define a metamethod
for __eq
, then mlua will check the second value.
Then mlua calls the metamethod with the two values as arguments, if found.
Trait Implementations
Auto Trait Implementations
impl<'lua> !RefUnwindSafe for Value<'lua>
impl<'lua> !UnwindSafe for Value<'lua>
Blanket Implementations
Mutably borrows from an owned value. Read more