Enum ReturnKind 

pub enum ReturnKind {
    Void,
    MayContainResources,
    AssumeNoResources,
}

Categorizes a function’s return for dispatch handling.

Determines how return values are processed during cross-plugin dispatch. Resources require special wrapping to track ownership across plugin boundaries, while plain data can be passed through directly.

Choosing the Right Variant

When uncertain, use MayContainResources. Using AssumeNoResources when resources are actually present will cause resource handles to be passed through unwrapped causing runtime exceptions.

AssumeNoResources is a performance optimization that skips the wrapping step. Only use it when you are certain the return type contains no resource handles anywhere in its structure (including nested within records, variants, lists, etc.).

Variants

Void

Function returns nothing (void).

MayContainResources

Function may return resource handles - always wraps safely.

Use this variant whenever resources might be present in the return value, or when you’re unsure. The performance overhead of wrapping is preferable to the undefined behavior caused by unwrapped resource handles.

AssumeNoResources

Assumes no resource handles are present - skips wrapping for performance.

Warning: Only use this if you are certain no resources are present. If resources are returned but this variant is used, resource handles will not be wrapped correctly, potentially causing undefined behavior in plugins. When in doubt, use MayContainResources instead.

Trait Implementations

impl Clone for ReturnKind

fn clone(&self) -> ReturnKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReturnKind

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

Formats the value using the given formatter.

impl Default for ReturnKind

fn default() -> ReturnKind

Returns the “default value” for a type.

impl Display for ReturnKind

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

Formats the value using the given formatter.

impl Hash for ReturnKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ReturnKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ReturnKind

impl Eq for ReturnKind

impl StructuralPartialEq for ReturnKind