Expand description
§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 IntoLua 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 IntoLuaMulti 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 and other types implement serde::Serialize trait to support serializing
Lua values into Rust values.
Requires feature = "serde".
§Async/await support
The Lua::create_async_function allows creating non-blocking functions that returns
Future. Lua code with async capabilities can be executed by Function::call_async family
of functions or polling AsyncThread using any runtime (eg. Tokio).
Requires feature = "async".
§Send and Sync support
By default mlua is !Send. This can be changed by enabling feature = "send" that adds a
Send requirement to Rust functions and a Send + Sync requirement to UserData types.
A Send-only userdata types must therefore be wrapped (e.g. in a Mutex) or created through a
Scope to be used with the send feature.
In this case Lua object and their types can be send or used from other threads. Internally
access to Lua VM is synchronized using a reentrant mutex that can be locked many times within
the same thread.
Modules§
- chunk
- Lua chunk loading and execution.
- debug
- Lua debugging interface.
- error
- Lua error handling.
- ffi
- Low level bindings to Lua 5.5/5.4/5.3/5.2/5.1 (including LuaJIT) and Luau.
- function
- Lua function handling.
- prelude
- Re-exports most types with an extra
Lua*prefix to prevent name clashes. - serde
- (De)Serialization support using serde.
- state
- Lua state management.
- string
- Lua string handling.
- table
- Lua table handling.
- thread
- Lua thread (coroutine) handling.
- userdata
- Lua userdata handling.
Structs§
- AnyUser
Data - Handle to an internal Lua userdata for any type that implements
UserData. - AppData
Ref - A wrapper type for an immutably borrowed value from an app data container.
- AppData
RefMut - A wrapper type for a mutably borrowed value from an app data container.
- BString
- A wrapper for
Vec<u8>that provides convenient string oriented trait impls. - Borrowed
Bytes - A borrowed byte slice (
&[u8]) that holds a strong reference to the Lua state. - Borrowed
Str - A borrowed string (
&str) that holds a strong reference to the Lua state. - Function
- Handle to an internal Lua function.
- Hook
Triggers - Determines when a hook function will be called by Lua.
- Light
User Data - A “light” userdata value. Equivalent to an unmanaged raw pointer.
- Lua
- Top level Lua struct which represents an instance of Lua VM.
- LuaOptions
- Controls Lua interpreter behavior such as Rust panics handling.
- LuaString
- Handle to an internal Lua string.
- Multi
Value - Multiple Lua values used for both argument passing and also for multiple return values.
- Registry
Key - An auto generated key into the Lua registry.
- Scope
- Constructed by the
Lua::scopemethod, allows temporarily creating Lua userdata and callbacks that are not required to beSendor'static. - Serializable
Value - A wrapped
Valuewith customized serialization behavior. - StdLib
- Flags describing the set of lua standard libraries to load.
- Table
- Handle to an internal Lua table.
- Thread
- Handle to an internal Lua thread (coroutine).
- User
Data Owned - A wrapper type that takes ownership of a userdata value.
- User
Data Ref - A wrapper type for a userdata value that provides read access.
- User
Data RefMut - A wrapper type for a userdata value that provides read and write access.
- User
Data Registry - Handle to registry for userdata methods and metamethods.
- Variadic
- Wraps a variable number of
Ts. - WeakLua
- Weak reference to Lua instance.
- lua_
State - A raw Lua state associated with a thread.
Enums§
- Either
- The enum
Eitherwith variantsLeftandRightis a general purpose sum type with two cases. - Error
- Error type returned by
mluamethods. - Meta
Method - Kinds of metamethods that can be overridden.
- Value
- A dynamically typed Lua value.
- VmState
- Type to set next Lua VM action after executing interrupt or hook function.
Traits§
- Error
Context - Provides the
contextmethod forErrorandResult<T, Error>. - External
Error - Trait for converting
std::error::Errorinto LuaError. - External
Result - Trait for converting
std::result::Resultinto LuaResult. - FromLua
- Trait for types convertible from
Value. - From
LuaMulti - Trait for types that can be created from an arbitrary number of Lua values.
- IntoLua
- Trait for types convertible to
Value. - Into
LuaMulti - Trait for types convertible to any number of Lua values.
- LuaSerde
Ext - Trait for serializing/deserializing Lua values using Serde.
- Maybe
Send - A trait that adds
Sendrequirement ifsendfeature is enabled. - Maybe
Sync - Adds a
Syncrequirement to userdata types when thesendfeature is enabled. - Object
Like - A trait for types that can be used as Lua objects (usually table and userdata).
- User
Data - Trait for custom userdata types.
- User
Data Fields - Field registry for
UserDataimplementors. - User
Data Methods - Method registry for
UserDataimplementors.
Type Aliases§
- Integer
- Type of Lua integer numbers.
- Number
- Type of Lua floating point numbers.
- Result
- A specialized
Resulttype used bymlua’s API. - lua_
CFunction - Type for native C functions that can be passed to Lua