Enum AsyncReturnValue 

pub enum AsyncReturnValue {
    Value(LuaValue),
    String(String),
    UserData(LuaUserdata),
}

Return value from an async function.

Because LuaValue strings are GC-managed and can only be created through the VM, async futures cannot directly construct string LuaValues. Instead, they return AsyncReturnValues which are converted to LuaValues by the AsyncThread after the future completes (using the VM’s string interner).

For non-GC types (integers, floats, booleans, nil), the value is stored directly as a LuaValue. For strings, an owned String is stored and later interned via vm.create_string(). For userdata, a LuaUserdata is stored and later GC-allocated via vm.create_userdata().

Variants

Value(LuaValue)

A value that doesn’t need GC allocation (integer, float, bool, nil, lightuserdata)

String(String)

A string that needs to be interned via the VM’s string pool

UserData(LuaUserdata)

A userdata that needs to be GC-allocated via the VM

Implementations

impl AsyncReturnValue

pub fn nil() -> Self

Create a nil return value

pub fn integer(n: i64) -> Self

Create an integer return value

pub fn float(n: f64) -> Self

Create a float return value

pub fn boolean(b: bool) -> Self

Create a boolean return value

pub fn string(s: impl Into<String>) -> Self

Create a string return value (will be interned when passed back to Lua)

pub fn userdata<T: UserDataTrait>(data: T) -> Self

Create a userdata return value (will be GC-allocated when passed back to Lua)

Trait Implementations

impl From<&str> for AsyncReturnValue

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<LuaUserdata> for AsyncReturnValue

fn from(ud: LuaUserdata) -> Self

Converts to this type from the input type.

impl From<LuaValue> for AsyncReturnValue

fn from(v: LuaValue) -> Self

Converts to this type from the input type.

impl From<String> for AsyncReturnValue

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<bool> for AsyncReturnValue

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f64> for AsyncReturnValue

fn from(n: f64) -> Self

Converts to this type from the input type.

impl From<i64> for AsyncReturnValue

Convenience conversions

fn from(n: i64) -> Self

Converts to this type from the input type.