Struct Function

pub struct Function {
    pub name: String,
    pub params: Vec<Param>,
    pub returns: Option<Type>,
    pub async: bool,
}

A single host function exposed to Python.

Fields

name: String

Function name; must be a valid ASCII identifier and must not be one of the reserved __async_* control names.

params: Vec<Param>

Typed parameters, in call order.

returns: Option<Type>

Return type, or None for a void function.

async: bool

Whether the function is asynchronous. Async functions must currently return Type::String; at the WASM level they return an i64 token that the guest resolves to an awaitable via boomslang_host.asyncio.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Function

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Function

fn eq(&self, other: &Function) -> 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 Serialize for Function

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Function