Struct InputDef 

pub struct InputDef {
    pub name: String,
    pub data_type: DataType,
    pub meaning: FieldMeaning,
    pub required: bool,
    pub description: Option<String>,
}

An input parameter definition for an action.

Reuses DataType and FieldMeaning from the field module to maintain a single type vocabulary across the projection schema.

Fields

name: String

data_type: DataType

meaning: FieldMeaning

required: bool

description: Option<String>

Implementations

impl InputDef

pub fn new( name: impl Into<String>, data_type: DataType, meaning: FieldMeaning, ) -> Self

Creates a new required input parameter.

pub fn required(self, required: bool) -> Self

Sets whether this input is required.

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

Sets the input description.

Trait Implementations

impl Clone for InputDef

fn clone(&self) -> InputDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for InputDef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for InputDef

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InputDef

impl StructuralPartialEq for InputDef