[][src]Crate mlua

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.

Re-exports

pub use crate::value::Nil;

Modules

prelude

Re-exports most types with an extra Lua* prefix to prevent name clashes.

Structs

AnyUserData

Handle to an internal Lua userdata for any type that implements UserData.

Chunk

Returned from Lua::load and is used to finalize loading and executing Lua main chunks.

Function

Handle to an internal Lua function.

LightUserData

A "light" userdata value. Equivalent to an unmanaged raw pointer.

Lua

Top level Lua struct which holds the Lua state itself.

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 Lua::scope method, allows temporarily creating Lua userdata and callbacks that are not required to be Send or 'static.

StdLib

Flags describing the set of lua modules 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 Ts.

Enums

Error

Error type returned by mlua methods.

MetaMethod

Kinds of metamethods that can be overridden.

ThreadStatus

Status of a Lua thread (or coroutine).

Value

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, or between a parent Lua instance and one received as a parameter in a Rust callback, and doing so will result in a panic.

Traits

ExternalError
ExternalResult
FromLua

Trait for types convertible from Value.

FromLuaMulti

Trait for types that can be created from an arbitrary number of Lua values.

ToLua

Trait for types convertible to Value.

ToLuaMulti

Trait for types convertible to any number of Lua values.

UserData

Trait for custom userdata types.

UserDataMethods

Method registry for UserData implementors.

Type Definitions

Integer

Type of Lua integer numbers.

Number

Type of Lua floating point numbers.

Result

A specialized Result type used by mlua's API.

lua_State