Struct DynamicReturn

#[repr(transparent)]
pub struct DynamicReturn<T> {
    pub data: Cell,
    /* private fields */
}

A type for a function’s return value that may have a more dynamic casting nature than usual.

The analyzer will assume that the return type belongs to the type family of the T type, but the Script Engine will not automatically upcast the Rust value, allowing the implementation to manually cast the result into a Cell.

#[export]
fn string_or_number(is_string: bool) -> RuntimeResult<DynamicReturn<usize>> {
    match is_string {
        true => Ok(DynamicReturn::new(Cell::give(Origin::nil(), "string")?)),
        false => Ok(DynamicReturn::new(Cell::give(Origin::nil(), 100usize)?)),
    }
}

Fields

data: Cell

The underlying return object.

Implementations

impl<T> DynamicReturn<T>

pub fn new(data: Cell) -> Self

A constructor that wraps the provided data Cell into a DynamicReturn.

Trait Implementations

impl<'a, T: ScriptType> Upcast<'a> for DynamicReturn<T>

type Output = Cell

A type into which the input type will be upcasted.

fn upcast(_origin: Origin, this: Self) -> RuntimeResult<Self::Output>

Creates Script data from Rust data.

fn hint() -> TypeHint

Returns a rough estimation of the Script type (or a set of types) into which the source Rust type could be upcasted.