Struct CliArgs 

pub struct CliArgs {
    pub command: CliCommand,
    pub verbose: Verbosity<InfoLevel>,
}

CLI arguments.

Fields

command: CliCommand

The command to be run.

verbose: Verbosity<InfoLevel>

Verbosity.

Implementations

impl CliArgs

pub fn new() -> Self

Parse CLI arguments from the environment.

pub fn new_from_args<I, T>(args: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse CLI arguments from an iterator.

pub fn run_cli(self)

Entrypoint for cli - process arguments and run commands.

Process exits on error.

pub fn run_with_io(self, input: impl Read) -> Result<Vec<u8>, RunWithIoError>

Run a CLI command with bytes input and capture bytes output.

This provides a programmatic interface to the CLI. Unlike run_cli(), this method:

• Accepts input instead of reading from stdin/files
• Returns output as a byte vector instead of writing to stdout/files

Arguments

• input - The input data as bytes (e.g., a HUGR package)

Returns

Returns Ok(Vec<u8>) with the command output, or an error on failure.

Note

The gen-extensions and external commands don’t support byte I/O and should use the normal run_cli() method instead.

Trait Implementations

impl Args for CliArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for CliArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for CliArgs

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

Formats the value using the given formatter.

impl Default for CliArgs

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for CliArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CliArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.