Struct Function 

pub struct Function {
    pub name: String,
    pub params: Vec<Param>,
    pub returns: Option<TypeRef>,
    pub doc: Option<String>,
    pub async: bool,
    pub cancellable: bool,
    pub deprecated: Option<String>,
    pub since: Option<String>,
}

A function exported across the FFI boundary.

Each function becomes a C ABI entry point plus an idiomatic wrapper in every target language. The async and cancellable flags change how the symbol is lowered (a completion callback, an extra cancel-token parameter) without altering the parameter and return shape declared here.

Fields

name: String

Function name, lowered to a per-language symbol (for example create_contact).

params: Vec<Param>

Ordered parameter list; order is preserved in every generated signature.

returns: Option<TypeRef>

Return type, or None for a function that returns nothing. Serialized under the IDL key return.

doc: Option<String>

Human-readable documentation, propagated to the generated bindings’ doc comments. None when undocumented.

async: bool

Whether the function is asynchronous, lowering to a completion-callback form rather than a blocking call. Serialized under the IDL key async.

cancellable: bool

Whether an async call accepts a cancellation token so callers can request that an in-flight operation stop early. Defaults to false.

deprecated: Option<String>

Deprecation notice; when set, generators emit a deprecation annotation carrying this message. None means the function is current.

since: Option<String>

Version in which the function was introduced (for example 0.2.0), surfaced as a “since” annotation where the target language supports one.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate 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 Eq for Function

impl JsonSchema for Function

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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