Skip to main content

Task

mlua_isle

Struct Task 

Source 
pub struct Task<T = String> { /* private fields */ }
Expand description

Handle to a pending Lua operation.

The operation runs on the Lua thread. The caller can:

  • wait for the result (blocking).
  • cancel the operation.
  • try_recv to poll without blocking.

Implementations§

Source§

impl<T> Task<T>

Source

pub fn wait(self) -> Result<T, IsleError>

Block until the result is available.

Source

pub fn cancel(&self)

Cancel the operation.

This signals the Lua debug hook to interrupt execution. The task will eventually return IsleError::Cancelled.

Source

pub fn try_recv(&self) -> Option<Result<T, IsleError>>

Non-blocking poll for the result.

Source

pub fn cancel_token(&self) -> &CancelToken

Access the cancel token (e.g. to share with other code).

Auto Trait Implementations§

§

impl<T> Freeze for Task<T>

§

impl<T> RefUnwindSafe for Task<T>

§

impl<T> Send for Task<T>
where T: Send,

§

impl<T = String> !Sync for Task<T>

§

impl<T> Unpin for Task<T>

§

impl<T> UnsafeUnpin for Task<T>

§

impl<T> UnwindSafe for Task<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> MaybeSend for T