pub enum Value<'lua> {
Nil,
Boolean(bool),
LightUserData(LightUserData),
Integer(Integer),
Number(Number),
Vector(f32, f32, f32),
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)
The Lua value true
or false
.
LightUserData(LightUserData)
A “light userdata” object, equivalent to a raw pointer.
Integer(Integer)
An integer number.
Any Lua number convertible to a Integer
will be represented as this variant.
Number(Number)
A floating point number.
Vector(f32, f32, f32)
luau
only.A Luau vector.
String(String<'lua>)
An interned string, managed by Lua.
Unlike Rust strings, Lua strings may not be valid UTF-8.
Table(Table<'lua>)
Reference to a Lua table.
Function(Function<'lua>)
Reference to a Lua function (or closure).
Thread(Thread<'lua>)
Reference to a Lua thread (or coroutine).
UserData(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)
Error
is a special builtin userdata type. When received from Lua it is implicitly cloned.
Implementations
sourceimpl<'lua> Value<'lua>
impl<'lua> Value<'lua>
pub const fn type_name(&self) -> &'static str
sourcepub fn equals<T: AsRef<Self>>(&self, other: T) -> Result<bool>
pub fn equals<T: AsRef<Self>>(&self, other: T) -> Result<bool>
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
sourceimpl<'lua> FromIterator<Value<'lua>> for MultiValue<'lua>
impl<'lua> FromIterator<Value<'lua>> for MultiValue<'lua>
sourcefn from_iter<I: IntoIterator<Item = Value<'lua>>>(iter: I) -> Self
fn from_iter<I: IntoIterator<Item = Value<'lua>>>(iter: I) -> Self
Creates a value from an iterator. Read more
Auto Trait Implementations
impl<'lua> !RefUnwindSafe for Value<'lua>
impl<'lua> !Send for Value<'lua>
impl<'lua> !Sync for Value<'lua>
impl<'lua> Unpin for Value<'lua>
impl<'lua> !UnwindSafe for Value<'lua>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Serialize for T where
T: Serialize + ?Sized,
impl<T> Serialize for T where
T: Serialize + ?Sized,
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more