Struct AuditCli 

pub struct AuditCli {
    pub command: AuditCommand,
    pub verbose: bool,
    pub quiet: bool,
    pub config: Option<PathBuf>,
}

Available on crate feature doc-audit only.

Documentation audit system for ADK-Rust.

Fields

command: AuditCommand

verbose: bool

Enable verbose output

quiet: bool

Enable quiet mode (minimal output)

config: Option<PathBuf>

Configuration file path

Implementations

impl AuditCli

pub fn parse_args() -> AuditCli

Parse command line arguments and create configuration.

pub fn to_config(&self) -> Result<AuditConfig, AuditError>

Convert CLI arguments to AuditConfig.

pub fn get_output_path(&self) -> Option<&PathBuf>

Get the output file path for commands that support it.

pub fn get_output_format(&self) -> OutputFormat

Get the output format for the current command.

pub fn get_output_path_with_default(&self) -> Option<PathBuf>

Get the output file path with default filename if format requires file output.

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

Get the crate name for single crate audit.

pub fn get_single_crate_options( &self, ) -> Option<(Option<&String>, Option<&PathBuf>)>

Get the single crate options for audit command.

pub fn get_changed_files(&self) -> Option<&[PathBuf]>

Get the changed files for incremental audit.

pub fn get_validate_file(&self) -> Option<&PathBuf>

Get the file path for single file validation.

pub fn get_init_config_path(&self) -> Option<&PathBuf>

Get the configuration path for init command.

pub fn get_stats_limit(&self) -> Option<usize>

Get the limit for stats command.

pub fn get_ci_options(&self) -> Option<(bool, usize, bool)>

Get CI/CD specific options for audit command.

Trait Implementations

impl Args for AuditCli

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 AuditCli

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 FromArgMatches for AuditCli

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

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<AuditCli, 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 AuditCli

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.