Struct LuaOptions

#[non_exhaustive]
pub struct LuaOptions {
    pub catch_rust_panics: bool,
    pub thread_cache_size: usize,
}

Controls Lua interpreter behavior such as Rust panics handling.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

catch_rust_panics: bool

Catch Rust panics when using pcall/xpcall.

If disabled, wraps these functions and automatically resumes panic if found. Also in Lua 5.1 adds ability to provide arguments to xpcall similar to Lua >= 5.2.

If enabled, keeps pcall/xpcall unmodified. Panics are still automatically resumed if returned to the Rust side.

Default: true

thread_cache_size: usize

Available on crate feature async only.

Max size of thread (coroutine) object cache used to execute asynchronous functions.

It works on Lua 5.4, LuaJIT (vendored) and Luau, where lua_resetthread function is available and allows to reuse old coroutines with reset state.

Default: 0 (disabled)

Implementations

impl LuaOptions

pub const fn new() -> Self

Returns a new instance of LuaOptions with default parameters.

pub const fn catch_rust_panics(self, enabled: bool) -> Self

Sets catch_rust_panics option.

pub const fn thread_cache_size(self, size: usize) -> Self

Available on crate feature async only.

Sets thread_cache_size option.

Trait Implementations

impl Clone for LuaOptions

fn clone(&self) -> LuaOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LuaOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LuaOptions

fn default() -> Self

Returns the “default value” for a type.