Struct ParamDescriptor 

pub struct ParamDescriptor {
    pub name: String,
    pub description: String,
    pub schema: ValueSchema,
    pub required: bool,
    pub numeric_shorthand: bool,
    pub positional: bool,
}

A function parameter.

Fields

name: String

description: String

schema: ValueSchema

required: bool

numeric_shorthand: bool

Whether a string may be used as a numeric shorthand for this parameter.

positional: bool

Whether the parameter may be supplied positionally in expressions.

Implementations

impl ParamDescriptor

pub fn required( name: impl Into<String>, description: impl Into<String>, schema: ValueSchema, ) -> ParamDescriptor

pub fn optional( name: impl Into<String>, description: impl Into<String>, schema: ValueSchema, ) -> ParamDescriptor

pub fn with_shorthand(self, allowed: bool) -> Self

pub fn with_positional(self, allowed: bool) -> Self

Trait Implementations

impl Clone for ParamDescriptor

fn clone(&self) -> ParamDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParamDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ParamDescriptor

fn eq(&self, other: &ParamDescriptor) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ParamDescriptor

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 ParamDescriptor