Skip to main content

ParsedCommand

Struct ParsedCommand 

Source
pub struct ParsedCommand {
    pub command: Word,
    pub args: Vec<CommandArg>,
}
Expand description

Structurally decomposed command with arguments in source order.

Schema-free parse: flags are identified syntactically (tokens starting with -). Without a command’s flag definitions, --flag value is ambiguous — the value appears as a separate positional. Schema-aware consumers walk args to associate values with flags they know about.

Fields§

§command: Word

Base command name (path stripped, env vars skipped).

§args: Vec<CommandArg>

Arguments in source order — flags and positionals interleaved.

Implementations§

Source§

impl ParsedCommand

Source

pub fn from_words(words: &[Word]) -> Self

Construct a ParsedCommand directly from a word slice, avoiding a string round-trip through shlex.

Source

pub fn subcommand(&self) -> Option<&str>

First positional argument (often a subcommand).

Source

pub fn flags(&self) -> impl Iterator<Item = &ParsedFlag>

Iterate over all flags.

Source

pub fn positional(&self) -> impl Iterator<Item = &str>

Iterate over all positional arguments.

Source

pub fn has_flag(&self, name: &str) -> bool

Check if a flag is present by name (e.g., --force or -f).

Source

pub fn to_words(&self) -> Vec<Word>

Reconstruct a flat word list.

Trait Implementations§

Source§

impl Clone for ParsedCommand

Source§

fn clone(&self) -> ParsedCommand

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 Debug for ParsedCommand

Source§

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

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

impl Eq for ParsedCommand

Source§

impl PartialEq for ParsedCommand

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ParsedCommand

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, 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.