Struct TemplateFunction 

pub struct TemplateFunction {
    pub name: String,
    pub description: String,
    pub parameters: Vec<FunctionParameter>,
    pub return_type: String,
    pub examples: Vec<String>,
    pub category: Option<String>,
    pub pure: bool,
}

Template function metadata

Fields

name: String

Function name

description: String

Function description

parameters: Vec<FunctionParameter>

Function parameters

return_type: String

Return type description

examples: Vec<String>

Examples of usage

category: Option<String>

Function category/tag

pure: bool

Whether function is pure (same inputs = same outputs)

Implementations

impl TemplateFunction

pub fn new<S: Into<String>>(name: S, description: S, return_type: S) -> Self

Create a new template function

pub fn with_parameter(self, param: FunctionParameter) -> Self

Add a parameter

pub fn with_parameters(self, params: Vec<FunctionParameter>) -> Self

Add multiple parameters

pub fn with_example<S: Into<String>>(self, example: S) -> Self

Add an example

pub fn with_category<S: Into<String>>(self, category: S) -> Self

Set category

pub fn impure(self) -> Self

Mark as impure

pub fn param_count(&self) -> usize

Get parameter count

pub fn has_var_args(&self) -> bool

Check if function has variable arguments

Trait Implementations

impl Clone for TemplateFunction

fn clone(&self) -> TemplateFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TemplateFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TemplateFunction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.