Struct ThreadTriggers 

#[non_exhaustive]
pub struct ThreadTriggers {
    pub on_create: bool,
    pub on_resume: bool,
    pub on_yield: bool,
}

Controls which thread lifecycle events trigger the callback.

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.

on_create: bool

Trigger the callback when a new thread is created.

On Luau this fires for every thread creation, on other Lua versions only for threads created via Lua::create_thread.

on_resume: bool

Trigger the callback before a thread is resumed via Thread::resume (or an async resume driven by mlua). It does not fire for a coroutine.resume performed inside Lua code.

on_yield: bool

Trigger the callback after a thread yields back to a Thread::resume driven by mlua. It does not fire for a yield consumed by a coroutine.resume inside Lua code.

Implementations

impl ThreadTriggers

pub const ON_CREATE: Self

An instance of ThreadTriggers with on_create trigger set.

pub const ON_RESUME: Self

An instance of ThreadTriggers with on_resume trigger set.

pub const ON_YIELD: Self

An instance of ThreadTriggers with on_yield trigger set.

pub const fn new() -> Self

Returns a new instance of ThreadTriggers with all triggers disabled.

pub const fn on_create(self) -> Self

Returns an instance of ThreadTriggers with on_create trigger set.

pub const fn on_resume(self) -> Self

Returns an instance of ThreadTriggers with on_resume trigger set.

pub const fn on_yield(self) -> Self

Returns an instance of ThreadTriggers with on_yield trigger set.

Trait Implementations

impl BitOr for ThreadTriggers

type Output = ThreadTriggers

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for ThreadTriggers

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for ThreadTriggers

fn clone(&self) -> ThreadTriggers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ThreadTriggers

impl Debug for ThreadTriggers

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

Formats the value using the given formatter.

impl Default for ThreadTriggers

fn default() -> ThreadTriggers

Returns the “default value” for a type.