Skip to main content Crate rlua Copy item path Source ffi Low level bindings to Lua 5.4/5.3/5.2/5.1 (including LuaJIT) and Luau. prelude chunk AnyUser Handle to an internal Lua userdata for any type that implements UserData AppData A wrapper type for an immutably borrowed value from an app data container. AppData A wrapper type for a mutably borrowed value from an app data container. Chunk Returned from Lua::load Debug Contains information about currently executing Lua code. Debug Debug Debug Function Handle to an internal Lua function. Function Contains information about a function. Hook Determines when a hook function will be called by Lua. Light 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. Multi Multiple Lua values used for both argument passing and also for multiple return values. Registry An auto generated key into the Lua registry. Scope Constructed by the Lua::scope 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. Table An iterator over the pairs of a Lua table. Table An iterator over the sequence part of a Lua table. Thread Handle to an internal Lua thread (coroutine). User Handle to a UserData metatable. User A wrapper type for an immutably borrowed value from a AnyUserData. User A wrapper type for a mutably borrowed value from a AnyUserData. User Handle to registry for userdata methods and metamethods. Variadic Wraps a variable number of Ts. lua_ A raw Lua state associated with a thread. Chunk Represents chunk mode (text or binary). Debug Represents a specific event that triggered the hook. Error Error type returned by mlua methods. GCMode Mode of the Lua garbage collector (GC). Meta Kinds of metamethods that can be overridden. Thread Status of a Lua thread (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, and doing so will result in a panic. AnyUser An extension trait for AnyUserData AsChunk Trait for types loadable by Lua and convertible to a Chunk Error Provides the context method for ErrorResult<T, Error>. External Trait for converting std::error::ErrorError External Trait for converting std::result::ResultResult FromLua Trait for types convertible from Value. From Trait for types that can be created from an arbitrary number of Lua values. IntoLua Trait for types convertible to Value. Into Trait for types convertible to any number of Lua values. Rlua Table An extension trait for Tables that provides a variety of convenient functionality. ToLua Trait for types convertible to Value. ToLua User Trait for custom userdata types. User Field registry for UserData User Method registry for UserData Context Integer Type of Lua integer numbers. Number Type of Lua floating point numbers. Result A specialized Result type used by mlua’s API. lua_ Type for native C functions that can be passed to Lua FromLua