Skip to main content

NativeReturn

Enum NativeReturn 

Source
#[non_exhaustive]
pub enum NativeReturn { Return(MultiValue), Error(Value), Wait(WaitRequest), CallLua { function: Value, args: MultiValue, tag: u32, keep: MultiValue, }, CallLuaNoYield { function: Value, args: MultiValue, tag: u32, keep: MultiValue, }, }
Expand description

A native’s results or its next execution request. Calls never recurse into the executor: Lua runs after the callback and its borrows end.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Return(MultiValue)

Return an exact sequence, including nil holes.

§

Error(Value)

Raise an arbitrary Lua error object.

§

Wait(WaitRequest)

Suspend until the host completes the VM-issued key.

§

CallLua

Call a callable Lua value and resume this symbol in a new VM step. Yields may cross this frame whenever the containing thread may yield.

Fields

§function: Value

A function or a value with __call.

§args: MultiValue

The call’s arguments.

§tag: u32

An application-defined continuation discriminator.

§keep: MultiValue

Values kept alive until the continuation resumes.

§

CallLuaNoYield

Call a Lua value behind a non-yielding C-call boundary.

The calling thread reports coroutine.isyieldable() == false until this call returns. Attempts to yield across it raise Lua’s catchable attempt to yield across a C-call boundary error in a coroutine, or attempt to yield from outside a coroutine on the main thread. Child coroutines may still yield to their resumers. Host waits and fuel pauses remain allowed, and the boundary survives snapshots taken at either pause. Nested CallLua calls cannot relax this restriction. Results, errors, continuation tags and kept values behave exactly as for Self::CallLua.

Fields

§function: Value

A function or a value with __call.

§args: MultiValue

The call’s arguments.

§tag: u32

An application-defined continuation discriminator.

§keep: MultiValue

Values kept alive until the continuation resumes.

Trait Implementations§

Source§

impl Clone for NativeReturn

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NativeReturn

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<MultiValue> for NativeReturn

Source§

fn from(values: MultiValue) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.