Struct mlua::LuaOptions
source · #[non_exhaustive]pub struct LuaOptions {
pub catch_rust_panics: bool,
pub thread_pool_size: usize,
}
Expand description
Controls Lua interpreter behavior such as Rust panics handling.
Fields (Non-exhaustive)§
This struct is marked as 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_pool_size: usize
Available on crate feature
async
only.Max size of thread (coroutine) object pool used to execute asynchronous functions.
It works on Lua 5.4 and Luau, where lua_resetthread
function
is available and allows to reuse old coroutines after resetting their state.
Default: 0 (disabled)
Implementations§
source§impl LuaOptions
impl LuaOptions
sourcepub const fn catch_rust_panics(self, enabled: bool) -> Self
pub const fn catch_rust_panics(self, enabled: bool) -> Self
Sets catch_rust_panics
option.
sourcepub const fn thread_pool_size(self, size: usize) -> Self
Available on crate feature async
only.
pub const fn thread_pool_size(self, size: usize) -> Self
async
only.Sets thread_pool_size
option.
Trait Implementations§
source§impl Clone for LuaOptions
impl Clone for LuaOptions
source§fn clone(&self) -> LuaOptions
fn clone(&self) -> LuaOptions
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for LuaOptions
impl Debug for LuaOptions
Auto Trait Implementations§
impl RefUnwindSafe for LuaOptions
impl Send for LuaOptions
impl Sync for LuaOptions
impl Unpin for LuaOptions
impl UnwindSafe for LuaOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more