Struct AddonFunction 

pub struct AddonFunction {
    pub name: String,
    pub params: Vec<AddonParam>,
    pub returns: String,
    pub event: Option<String>,
    pub doc: String,
}

One function an add-on offers scripts.

Fields

name: String

The name a script calls it by, and the name of the module export that answers.

params: Vec<AddonParam>

Its parameters, in order.

returns: String

What it returns, as a type spelling. null for nothing, and always null for an asynchronous function, whose result arrives as an event.

event: Option<String>

The event an asynchronous function’s result arrives as, or None for a function that answers before it returns.

A script calls an asynchronous function with a tag after its declared arguments. When the module’s promise settles, the script’s <event> handler is called with the tag and the value, or <event>_error with the tag and the reason.

doc: String

One line describing it, for editor tooling.

Trait Implementations

impl Clone for AddonFunction

fn clone(&self) -> AddonFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddonFunction

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

Formats the value using the given formatter.

impl Default for AddonFunction

fn default() -> AddonFunction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AddonFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AddonFunction

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AddonFunction

impl StructuralPartialEq for AddonFunction