Struct FunctionDefinition

pub struct FunctionDefinition {
    pub name: &'static str,
    pub category: Option<&'static str>,
    pub description: &'static str,
    pub arguments: fn() -> Vec<FunctionArgument>,
    pub handler: FunctionHandler,
}

Holds the definition of a builtin callable function

Fields

name: &'static str

Function call name

category: Option<&'static str>

Function category

description: &'static str

Function short description

arguments: fn() -> Vec<FunctionArgument>

Vector of arguments the function supports

handler: FunctionHandler

Handler function

Implementations

impl FunctionDefinition

pub fn name(&self) -> &str

Return the function’s name

pub fn description(&self) -> &str

Return the function’s description

pub fn category(&self) -> &str

Return the function’s category

pub fn args(&self) -> Vec<FunctionArgument>

Return the function’s arguments

pub fn signature(&self) -> String

Return the function’s signature

pub fn help(&self) -> String

Return the function’s help string

pub fn collect( &self, args: &[Value], ) -> Result<FunctionArgumentCollection, ParserError>

Validate function arguments, and return the collected arguments

Arguments

• args - Function arguments

pub fn call( &self, state: &mut ParserState, args: &[Value], ) -> Result<Value, ParserError>

Arguments

• args - Function arguments

Trait Implementations

impl Clone for FunctionDefinition

fn clone(&self) -> FunctionDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.