Skip to main content

ArgType

Enum ArgType 

Source
pub enum ArgType {
    String,
    Path,
    Int,
    Duration,
    List,
    Any,
    OneOf(&'static [&'static str]),
    Rest(&'static ArgType),
}
Expand description

Closed vocabulary for argument value types: every variant names a type explicitly present in the app, so the reference table never lists a type that does not exist. Shapes ($var targets, KEY=value pairs) are not types: the central validator only checks value types and arity, while each command’s lower enforces its own shapes with command-specific errors. ArgType::Any is the single exception: it renders as <any>, visibly a placeholder rather than a type name. ArgType::OneOf renders its inline options, likewise self-describing.

Variants§

§

String

§

Path

§

Int

§

Duration

§

List

A $variable that must hold a LIST at runtime. Non-variable expressions fail at lower time; renders linked as LIST.

§

Any

Any evaluated value (plus stream markers like stdout where the command accepts them). Renders unlinked as <any>, visibly a placeholder rather than a type name.

§

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§

Source§

impl ArgType

Source

pub fn label(&self) -> String

Table-cell label for the argument table’s Type column. Canonical value types use their descriptor names; ANY renders as <any> and inline alternations render their options, so neither reads as a standalone type. Shapes ($var targets, KEY=value pairs) are validated in each command’s lower, and the shape requirement lives in the argument description and command syntax.

Source

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

Anchor of the type’s reference section. Only types with a value-type reference section link; <any> and inline alternations render unlinked.

Source

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.

Source

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 List is required), and mixed fragments defer to the runtime resolvers, which see interpolated values.

Trait Implementations§

Source§

impl Clone for ArgType

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ArgType

Source§

impl Debug for ArgType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ArgType

Source§

impl PartialEq for ArgType

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ArgType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more