Struct Parameter 

pub struct Parameter {
    pub name: String,
    pub param_type: ParameterType,
    pub required: bool,
    pub description: String,
    pub default: Option<Value>,
    pub enum_values: Vec<Value>,
}

A parameter definition for a tool.

Fields

name: String

The parameter name.

param_type: ParameterType

The parameter type.

required: bool

Whether this parameter is required.

description: String

Description of the parameter.

default: Option<Value>

Default value for the parameter.

enum_values: Vec<Value>

Enum of allowed values.

Implementations

impl Parameter

pub fn new(name: impl Into<String>) -> Self

Create a new parameter with the given name.

pub fn builder(name: impl Into<String>) -> ParameterBuilder

Create a builder for a parameter.

pub fn required_string(name: impl Into<String>) -> Self

Create a required string parameter.

pub fn optional_string(name: impl Into<String>) -> Self

Create an optional string parameter.

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Parameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Parameter

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Parameter