Struct FunctionParameter 

pub struct FunctionParameter {
    pub name: String,
    pub param_type: String,
    pub description: String,
    pub required: bool,
    pub default_value: Option<Value>,
    pub var_args: bool,
}

Function parameter definition

Fields

name: String

Parameter name

param_type: String

Parameter type

description: String

Parameter description

required: bool

Whether parameter is required

default_value: Option<Value>

Default value (if optional)

var_args: bool

Whether this parameter accepts variable arguments

Implementations

impl FunctionParameter

pub fn required<S>(name: S, param_type: S, description: S) -> FunctionParameter

where S: Into<String>,

Create a required parameter

pub fn optional<S>(name: S, param_type: S, description: S) -> FunctionParameter

where S: Into<String>,

Create an optional parameter

pub fn with_default<S>( name: S, param_type: S, description: S, default: Value, ) -> FunctionParameter

where S: Into<String>,

Create an optional parameter with default value

pub fn var_args<S>(name: S, param_type: S, description: S) -> FunctionParameter

where S: Into<String>,

Create a variable arguments parameter

Trait Implementations

impl Clone for FunctionParameter

fn clone(&self) -> FunctionParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionParameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionParameter

fn deserialize<__D>( __deserializer: __D, ) -> Result<FunctionParameter, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FunctionParameter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.