Struct Thread

pub struct Thread(/* private fields */);

Handle to an internal Lua thread (coroutine).

Implementations

impl Thread

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

where R: FromLuaMulti,

Resumes execution of this thread.

Equivalent to coroutine.resume.

Passes args as arguments to the thread. If the coroutine has called coroutine.yield, it will return these arguments. Otherwise, the coroutine wasn’t yet started, so the arguments are passed to its main function.

If the thread is no longer resumable (meaning it has finished execution or encountered an error), this will return Error::CoroutineUnresumable, otherwise will return Ok as follows:

If the thread calls coroutine.yield, returns the values passed to yield. If the thread returns values from its main function, returns those.

Examples

let thread: Thread = lua.load(r#"
    coroutine.create(function(arg)
        assert(arg == 42)
        local yieldarg = coroutine.yield(123)
        assert(yieldarg == 43)
        return 987
    end)
"#).eval()?;

assert_eq!(thread.resume::<u32>(42)?, 123);
assert_eq!(thread.resume::<u32>(43)?, 987);

// The coroutine has now returned, so `resume` will fail
match thread.resume::<u32>(()) {
    Err(Error::CoroutineUnresumable) => {},
    unexpected => panic!("unexpected result {:?}", unexpected),
}

pub fn status(&self) -> ThreadStatus

Gets the status of the thread.

pub fn set_hook<F>(&self, triggers: HookTriggers, callback: F)

where F: Fn(&Lua, Debug<'_>) -> Result<VmState> + MaybeSend + 'static,

Available on non-crate feature luau only.

Sets a hook function that will periodically be called as Lua code executes.

This function is similar or [Lua::set_hook] except that it sets for the thread. To remove a hook call [Lua::remove_hook].

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

Resets a thread

In Lua 5.4: cleans its call stack and closes all pending to-be-closed variables. Returns a error in case of either the original error that stopped the thread or errors in closing methods.

In Luau: resets to the initial state of a newly created Lua thread. Lua threads in arbitrary states (like yielded or errored) can be reset properly.

Other Lua versions can reset only new or finished threads.

Sets a Lua function for the thread afterwards.

pub fn into_async<R>( self, args: impl IntoLuaMulti, ) -> AsyncThread<impl IntoLuaMulti, R>

where R: FromLuaMulti,

Available on crate feature async only.

Converts Thread to an AsyncThread which implements Future and Stream traits.

args are passed as arguments to the thread function for first call. The object calls resume while polling and also allow to run Rust futures to completion using an executor.

Using AsyncThread as a Stream allow to iterate through coroutine.yield values whereas Future version discards that values and poll until the final one (returned from the thread function).

Requires feature = "async"

Examples

use futures_util::stream::TryStreamExt;
let thread: Thread = lua.load(r#"
    coroutine.create(function (sum)
        for i = 1,10 do
            sum = sum + i
            coroutine.yield(sum)
        end
        return sum
    end)
"#).eval()?;

let mut stream = thread.into_async::<i64>(1);
let mut sum = 0;
while let Some(n) = stream.try_next().await? {
    sum += n;
}

assert_eq!(sum, 286);

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

Converts this thread to a generic C pointer.

There is no way to convert the pointer back to its original value.

Typically this function is used only for hashing and debug information.

Trait Implementations

impl Clone for Thread

fn clone(&self) -> Thread

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Thread

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

Formats the value using the given formatter.

impl FromLua for Thread

fn from_lua(value: Value, _: &Lua) -> Result<Thread>

Performs the conversion.

impl IntoLua for &Thread

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

Performs the conversion.

impl IntoLua for Thread

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

Performs 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 Send for Thread

impl Sync for Thread