Enum RetPass 

pub enum RetPass {
    Void,
    Direct,
    String,
    Bytes,
    Buffer,
    Object {
        destroy_symbol: String,
        clone_symbol: String,
        nullable: bool,
    },
}

How a value produced by the producer crosses back to the wrapper: the receiving contract, including the decode step and the release obligation.

Sync returns, async results, and iterator elements all use this.

Variants

Void

No return value.

Direct

By-value return (scalar, bool, C-style enum): use directly, nothing to free.

String

Owned (const uint8_t*, out_len) UTF-8: decode into the native string, then release with {prefix}_free_bytes.

Bytes

Owned (const uint8_t*, out_len) raw bytes: copy, then release with {prefix}_free_bytes.

Buffer

Owned (const uint8_t*, out_len) value buffer: decode via the wire format (Ty::wire), adopting any object tokens it carries, then release with {prefix}_free_bytes.

Object

One strong object reference the wrapper adopts into its disposal idiom. When nullable, the IDL type is Interface? and a null return means none.

Fields

destroy_symbol: String

The {prefix}_{module}_{Name}_destroy symbol the adopted reference eventually owes.

clone_symbol: String

The {prefix}_{module}_{Name}_clone symbol the wrapper calls when it needs a second reference (for example to write the object into a value buffer).

nullable: bool

true for Interface?: a null return is a legal “none” result.

Implementations

impl RetPass

pub fn frees_bytes(&self) -> bool

Whether the wrapper owes {prefix}_free_bytes(ptr, len) after copying or decoding a returned value: true for strings, bytes, and value buffers. Adopted objects owe their destroy symbol instead (see RetPass::Object). Callback-method arguments reuse this plan but are borrowed for the call, so a trampoline never frees them.

Trait Implementations

impl Clone for RetPass

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetPass

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

Formats the value using the given formatter.

impl Eq for RetPass

impl PartialEq for RetPass

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RetPass