Struct Cli 

pub struct Cli {

    pub test: bool,
    pub mkdir: bool,
    pub overwrite: bool,
    pub extension: bool,
    pub directory: Option<PathBuf>,
    pub max_depth: Option<usize>,
    pub depth: Option<usize>,
    pub generate: Option<PathBuf>,
    pub print: bool,
    pub map: Option<PathBuf>,
    pub sort: Option<Order>,
    pub regex: Option<String>,
    pub output: Vec<String>,
}

Fields

test: bool

Runs in test mode without renaming actual files (dry-run).

mkdir: bool

Recursively creates all parent directories of ‘

’ if they are missing.

overwrite: bool

Overwrites output files, otherwise, a ‘_’ is prepended to filename.

extension: bool

Preserves the extension of input files in ‘sort’ and ‘regex’ options.

directory: Option<PathBuf>

Sets the working directory.

max_depth: Option<usize>

Optional value to set the maximum of subdirectory depth value in ‘regex’ mode.

depth: Option<usize>

Optional value to overwrite inferred subdirectory depth value in ‘regex’ mode.

generate: Option<PathBuf>

Stores a JSON map file in ‘’ after renaming files.

print: bool

Prints the map table to stdout.

map: Option<PathBuf>

Sets the path of map file to be used for renaming files.

sort: Option<Order>

Sets the order of natural sorting (by name) to rename files using enumerator.

regex: Option<String>

Regex pattern (RE2 syntax) to match by filenames.

output: Vec<String>

OUTPUT is the pattern to be used for renaming files, and SOURCE is the optional regex pattern to match by filenames. SOURCE has the same function as -r option.

Implementations

impl Cli

pub fn parse() -> Self

Trait Implementations

impl Args for Cli

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 Cli

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 Cli

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 Cli

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.