Crate mlua[−][src]
High-level bindings to Lua
The mlua
crate provides safe high-level bindings to the Lua programming language.
The Lua
object
The main type exported by this library is the Lua
struct. In addition to methods for
executing Lua chunks or evaluating Lua expressions, it provides methods for creating Lua
values and accessing the table of globals.
Converting data
The ToLua
and FromLua
traits allow conversion from Rust types to Lua values and vice
versa. They are implemented for many data structures found in Rust’s standard library.
For more general conversions, the ToLuaMulti
and FromLuaMulti
traits allow converting
between Rust types and any number of Lua values.
Most code in mlua
is generic over implementors of those traits, so in most places the normal
Rust data structures are accepted without having to write any boilerplate.
Custom Userdata
The UserData
trait can be implemented by user-defined types to make them available to Lua.
Methods and operators to be used from Lua can be added using the UserDataMethods
API.
Fields are supported using the UserDataFields
API.
Serde support
The LuaSerdeExt
trait implemented for Lua
allows conversion from Rust types to Lua values
and vice versa using serde. Any user defined data type that implements serde::Serialize
or
serde::Deserialize
can be converted.
For convenience, additional functionality to handle NULL
values and arrays is provided.
The Value
enum implements serde::Serialize
trait to support serializing Lua values
(including UserData
) into Rust values.
Requires feature = "serialize"
.
Async/await support
The create_async_function
allows creating non-blocking functions that returns Future
.
Lua code with async capabilities can be executed by call_async
family of functions or polling
AsyncThread
using any runtime (eg. Tokio).
Requires feature = "async"
.
Send
requirement
By default mlua
is !Send
. This can be changed by enabling feature = "send"
that adds Send
requirement
to Function
s and UserData
.
Re-exports
pub use crate::value::Nil; |
Modules
prelude | Re-exports most types with an extra |
serde | serialize (De)Serialization support using serde. |
Structs
AnyUserData | Handle to an internal Lua userdata for any type that implements |
AsyncThread | async Thread (coroutine) representation as an async |
Chunk | Returned from |
Debug | Contains information about currently executing Lua code. |
DebugNames | |
DebugSource | |
DebugStack | |
Function | Handle to an internal Lua function. |
HookTriggers | Determines when a hook function will be called by Lua. |
LightUserData | A “light” userdata value. Equivalent to an unmanaged raw pointer. |
Lua | Top level Lua struct which holds the Lua state itself. |
LuaOptions | Controls Lua interpreter behaviour such as Rust panics handling. |
MultiValue | Multiple Lua values used for both argument passing and also for multiple return values. |
RegistryKey | An auto generated key into the Lua registry. |
Scope | Constructed by the |
SerializeOptions | A struct with options to change default serializer behaviour. |
StdLib | Flags describing the set of lua standard libraries to load. |
String | Handle to an internal Lua string. |
Table | Handle to an internal Lua table. |
TablePairs | An iterator over the pairs of a Lua table. |
TableSequence | An iterator over the sequence part of a Lua table. |
Thread | Handle to an internal Lua thread (or coroutine). |
Variadic | Wraps a variable number of |
Enums
ChunkMode | Represents chunk mode (text or binary). |
Error | Error type returned by |
GCMode | Mode of the Lua garbage collector (GC). |
MetaMethod | Kinds of metamethods that can be overridden. |
ThreadStatus | Status of a Lua thread (or coroutine). |
Value | A dynamically typed Lua value. The |
Traits
ExternalError | |
ExternalResult | |
FromLua | Trait for types convertible from |
FromLuaMulti | Trait for types that can be created from an arbitrary number of Lua values. |
LuaSerdeExt | Trait for serializing/deserializing Lua values using Serde. |
TableExt | An extension trait for |
ToLua | Trait for types convertible to |
ToLuaMulti | Trait for types convertible to any number of Lua values. |
UserData | Trait for custom userdata types. |
UserDataFields | Field registry for |
UserDataMethods | Method registry for |
Type Definitions
Integer | Type of Lua integer numbers. |
Number | Type of Lua floating point numbers. |
Result | A specialized |
lua_State |