Struct FunctionDescriptor 

pub struct FunctionDescriptor {

    pub id: String,
    pub module: String,
    pub version: String,
    pub title: String,
    pub summary: String,
    pub description: String,
    pub parameters: Vec<ParamDescriptor>,
    pub output: ValueSchema,
    pub output_description: String,
    pub modes: Vec<NumericMode>,
    pub purity: Purity,
    pub determinism: Determinism,
    pub cost: CostClass,
    pub units_rule: String,
    pub method_ref: String,
    pub examples: Vec<Example>,
    pub deprecated: Option<Deprecation>,
    pub tags: Vec<String>,
}

The authoritative function declaration.

Fields

id: String

module: String

version: String

title: String

summary: String

description: String

parameters: Vec<ParamDescriptor>

output: ValueSchema

output_description: String

modes: Vec<NumericMode>

purity: Purity

determinism: Determinism

cost: CostClass

units_rule: String

method_ref: String

examples: Vec<Example>

deprecated: Option<Deprecation>

tags: Vec<String>

Implementations

impl FunctionDescriptor

pub fn new( id: impl Into<String>, module: impl Into<String>, version: impl Into<String>, title: impl Into<String>, summary: impl Into<String>, ) -> FunctionDescriptor

pub fn with_description(self, description: impl Into<String>) -> Self

pub fn with_parameters(self, parameters: Vec<ParamDescriptor>) -> Self

pub fn with_output( self, output: ValueSchema, description: impl Into<String>, ) -> Self

pub fn with_modes(self, modes: impl IntoIterator<Item = NumericMode>) -> Self

pub fn with_cost(self, cost: CostClass) -> Self

pub fn with_units_rule(self, rule: impl Into<String>) -> Self

pub fn with_method_ref(self, method_ref: impl Into<String>) -> Self

pub fn with_examples(self, examples: Vec<Example>) -> Self

pub fn with_tags( self, tags: impl IntoIterator<Item = impl Into<String>>, ) -> Self

pub fn with_deprecation(self, deprecation: Deprecation) -> Self

pub fn parameter(&self, name: &str) -> Option<&ParamDescriptor>

Trait Implementations

impl Clone for FunctionDescriptor

fn clone(&self) -> FunctionDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FunctionDescriptor

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 FunctionDescriptor