Struct Args 

pub struct Args {
    pub files: Vec<PathBuf>,
    pub exclude: Vec<String>,
    pub no_ignore: bool,
    pub hidden: bool,
    pub base_dir: Option<PathBuf>,
    pub max_size: u64,
    pub no_follow_symlinks: bool,
    pub format: OutputFormat,
    pub quiet: bool,
    pub output_dir: PathBuf,
    pub no_report: bool,
}

Validate whether files (or standard input) contain well-formed UTF-8, fast.

Fields

files: Vec<PathBuf>

Files or directories to validate. Directories are walked recursively. Use - or pass none to read standard input.

exclude: Vec<String>

Exclude paths matching this glob when walking directories (repeatable, gitignore syntax, e.g. --exclude '*.min.js' --exclude target).

no_ignore: bool

When walking directories, do not respect .gitignore / .ignore files (they are respected by default).

hidden: bool

When walking directories, also descend into hidden files and directories (skipped by default).

base_dir: Option<PathBuf>

Confine inputs to this base directory (rejects traversal & symlink escapes).

max_size: u64

Maximum number of bytes to read from each input.

no_follow_symlinks: bool

Reject symbolic links instead of resolving them.

format: OutputFormat

Output format for stdout.

quiet: bool

Suppress per-input output and rely on the exit code only.

output_dir: PathBuf

Directory for the auto-generated report.sarif / report.md files.

no_report: bool

Do not auto-generate the report.sarif / report.md files.

Trait Implementations

impl Args for Args

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 Args

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 Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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 Args

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.