Struct Args 

pub struct Args {

    pub root_dir: PathBuf,
    pub pattern: Option<String>,
    pub substitute: Option<String>,
    pub patterns_file: Option<PathBuf>,
    pub assume_yes: bool,
    pub verbose: bool,
    pub follow_symlinks: bool,
    pub backup: bool,
    pub files_only: bool,
    pub dirs_only: bool,
    pub names_only: bool,
    pub content_only: bool,
    pub max_depth: usize,
    pub exclude_patterns: Vec<String>,
    pub include_patterns: Vec<String>,
    pub format: OutputFormat,
    pub threads: usize,
    pub progress: ProgressMode,
    pub ignore_case: bool,
    pub use_regex: bool,
    pub include_hidden: bool,
    pub binary_names: bool,
}

Fields

root_dir: PathBuf

Root directory to search in

pattern: Option<String>

Pattern to find and replace (required unless –patterns-file is used)

substitute: Option<String>

Replacement text (required unless –patterns-file is used)

patterns_file: Option<PathBuf>

File containing pattern/substitute pairs, one pair per line with shell-style quoting

assume_yes: bool

Assume “yes” to confirmation prompts (non-interactive mode)

verbose: bool

Show detailed output

follow_symlinks: bool

Follow symbolic links

backup: bool

Create backup files before modifying content

files_only: bool

Only process files (skip directories)

dirs_only: bool

Only process directories (skip files)

names_only: bool

Skip content replacement, only rename files/directories

content_only: bool

Skip file/directory renaming, only replace content

max_depth: usize

Maximum depth to search (0 = unlimited)

exclude_patterns: Vec<String>

Exclude files matching these patterns (glob patterns)

include_patterns: Vec<String>

Include only files matching these patterns (glob patterns)

format: OutputFormat

Output format

threads: usize

Number of threads to use for processing (0 = auto)

progress: ProgressMode

Progress display mode

ignore_case: bool

Ignore case when matching patterns

use_regex: bool

Use regex patterns instead of literal strings

include_hidden: bool

Include hidden files and directories (starting with ‘.’)

binary_names: bool

Include binary file names in renaming operations (content will still be skipped)

Implementations

impl Args

pub fn get_mode(&self) -> Mode

pub fn validate(&self) -> Result<(), String>

pub fn should_process_files(&self) -> bool

pub fn should_process_dirs(&self) -> bool

pub fn should_process_content(&self) -> bool

pub fn should_process_names(&self) -> bool

pub fn get_thread_count(&self) -> usize

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 Clone for Args

fn clone(&self) -> Args

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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.