Struct ArgumentDefinition 

pub struct ArgumentDefinition {
    pub name: String,
    pub arg_type: ArgumentType,
    pub required: bool,
    pub description: String,
    pub validation: Vec<ValidationRule>,
}

Definition of a positional argument

Positional arguments are required in order and don’t have a flag prefix (unlike options).

Example

name: input_file
arg_type: path
required: true
description: "Path to input file"
validation:
  - must_exist: true
  - extensions: [yaml, yml]

Fields

name: String

Argument name (used in error messages and documentation)

arg_type: ArgumentType

Expected type of the argument

required: bool

Whether the argument is mandatory

description: String

Human-readable description

validation: Vec<ValidationRule>

Validation rules to apply

Trait Implementations

impl Clone for ArgumentDefinition

fn clone(&self) -> ArgumentDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArgumentDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ArgumentDefinition

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

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 ArgumentDefinition