Struct ApiFunction 

pub struct ApiFunction {
    pub name: String,
    pub doc: Option<String>,
    pub kind: ApiFunctionKind,
    pub is_async: bool,
    pub params: Vec<ApiParam>,
    pub result: Option<String>,
}

One function within an interface.

Resource methods are functions too: WIT names them [method]<resource>.<name> ([static]…, [constructor]<resource> likewise) and kind says which resource they belong to.

Fields

name: String

The WIT function name, e.g. walk or [method]document.line.

doc: Option<String>

The function’s /// doc comment, if any.

kind: ApiFunctionKind

Freestanding, or which resource it is a method / static / constructor of.

is_async: bool

Declared async in the WIT.

params: Vec<ApiParam>

Parameters in order. A method’s first parameter is self.

result: Option<String>

The result type in WIT syntax, or None for a function returning nothing.

Implementations

impl ApiFunction

pub fn display_name(&self) -> String

The name a reader calls it by: walk, document.line, document.new for a constructor. Strips WIT’s [method] / [static] / [constructor] mangling.

pub fn signature(&self) -> String

The function’s signature in WIT syntax, as it would be declared inside its interface (or its resource block): walk: func(opts: walk-options) -> result<list<string>, string>. A method’s implicit self is omitted, as WIT source omits it.

Trait Implementations

impl Clone for ApiFunction

fn clone(&self) -> ApiFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiFunction

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

Formats the value using the given formatter.

impl Eq for ApiFunction

impl PartialEq for ApiFunction

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApiFunction