Enum ArgType 

pub enum ArgType {
    String,
    Path,
    Int,
    Duration,
    Var,
    KeyValue,
    Any,
    OneOf(&'static [&'static str]),
    Rest(&'static ArgType),
}

Closed vocabulary for argument value types.

The closed enum keeps the vocabulary compiler-checked and lets docs-gen link each type cell to its reference section instead of printing bare words like duration with no explanation.

Variants

String

Path

Int

Duration

Var

KeyValue

Any

Any evaluated value (plus stream markers like stdout where the command accepts them). Renders unlinked as ANY.

OneOf(&'static [&'static str])

Inline alternation for one-off enums (e.g. SNAPSHOT|LOCAL). Self-describing, so it renders unlinked.

Rest(&'static ArgType)

Trailing variadic repetition (e.g. RUN’s string...).

Implementations

impl ArgType

pub fn label(&self) -> String

Table-cell label for the argument table’s Type column. Canonical value types use their descriptor names. Reference and assignment shapes ($var, KEY=value), inline alternations, and ANY render unlinked. Reference and assignment shapes display as the STRING values they bind or resolve to; the $/assignment requirement itself lives in the argument description and command syntax.

pub fn anchor(&self) -> Option<String>

Anchor of the type’s reference section. Only types with a value-type reference section link; argument shapes ($var, KEY=value), inline alternations, and ANY render unlinked.

pub fn validate_literal(&self, literal: &str) -> Result<()>

Validate a statically-known literal against this type. Templates and variables are never passed here — see check_arg.

pub fn check_arg(&self, arg: &Arg) -> Result<CheckOutcome>

Classify one positional arg for lower-time checking. Static literals validate now; templates, variables (except a $var where Var is required), and mixed fragments defer to the runtime resolvers, which see interpolated values.

Trait Implementations

impl Clone for ArgType

fn clone(&self) -> ArgType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ArgType

impl Debug for ArgType

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

Formats the value using the given formatter.

impl Eq for ArgType

impl PartialEq for ArgType

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ArgType