Struct Thread 

pub struct Thread { /* private fields */ }

A handle to a Lua thread (coroutine). Mirrors mlua::Thread.

Under the send feature it is Send but never Sync — see [crate::sync::NotSync].

Implementations

impl Thread

pub fn sandbox(&self) -> Result<()>

Sandbox this coroutine: install a fresh proxy global table on its own state so global writes inside the coroutine stay local to it. Mirrors mlua::Thread::sandbox.

impl Thread

pub fn lua(&self) -> Lua

The owning Lua.

pub fn state(&self) -> *mut lua_State

The raw coroutine state pointer. Mirrors mlua::Thread::state.

pub fn resume<R: FromLuaMulti>(&self, args: impl IntoLuaMulti) -> Result<R>

Resume the coroutine, passing args and converting its yielded/returned values to R. Mirrors mlua::Thread::resume.

Returns Error::CoroutineUnresumable if the thread has finished, errored, or is otherwise not resumable.

pub fn resume_error<R: FromLuaMulti>(&self, error: impl IntoLua) -> Result<R>

Resume the coroutine, immediately raising error inside it. Mirrors mlua::Thread::resume_error (a Luau extension).

pub fn status(&self) -> ThreadStatus

The thread’s status. Mirrors mlua::Thread::status.

pub fn is_resumable(&self) -> bool

Whether the thread can be resumed. Mirrors mlua::Thread::is_resumable.

pub fn is_running(&self) -> bool

Whether the thread is currently running. Mirrors mlua::Thread::is_running.

pub fn is_normal(&self) -> bool

Whether the thread is active but not running. Mirrors mlua::Thread::is_normal.

pub fn is_finished(&self) -> bool

Whether the thread has finished executing. Mirrors mlua::Thread::is_finished.

pub fn is_error(&self) -> bool

Whether the thread raised an error. Mirrors mlua::Thread::is_error.

pub fn reset(&self, func: Function) -> Result<()>

Reset the thread to a fresh state and install func as its body. Mirrors mlua::Thread::reset (Luau semantics: any non-running thread can be reset).

pub fn to_pointer(&self) -> *const c_void

A raw pointer identifying this thread. Mirrors mlua::Thread::to_pointer.

Trait Implementations

impl Clone for Thread

fn clone(&self) -> Thread

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Thread

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

Formats the value using the given formatter.

impl FromLua for Thread

fn from_lua(value: Value, _lua: &Lua) -> Result<Self>

Perform the conversion.

fn from_lua_arg( arg: Value, _i: usize, _to: Option<&str>, lua: &Lua, ) -> Result<Self>

Convert an argument at 1-based position i. The default forwards to FromLua::from_lua; specific impls can produce nicer messages. Mirrors mlua::FromLua::from_lua_arg.

impl IntoLua for Thread

fn into_lua(self, _lua: &Lua) -> Result<Value>

Perform the conversion.

impl IntoLua for &Thread

fn into_lua(self, _lua: &Lua) -> Result<Value>

Perform the conversion.

impl PartialEq for Thread

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMetatable for Thread

fn set_type_metatable(lua: &Lua, metatable: Option<Table>)

Install (or clear) the shared metatable for this type.

fn type_metatable(lua: &Lua) -> Option<Table>

The shared metatable for this type, if installed.