Struct stringsext::options::Args

pub struct Args {

    pub ascii_filter: Option<String>,
    pub no_metadata: bool,
    pub debug_option: bool,
    pub inputs: Vec<PathBuf>,
    pub encoding: Vec<String>,
    pub grep_char: Option<String>,
    pub list_encodings: bool,
    pub chars_min: Option<String>,
    pub same_unicode_block: bool,
    pub output: Option<PathBuf>,
    pub output_line_len: Option<String>,
    pub counter_offset: Option<String>,
    pub radix: Option<Radix>,
    pub unicode_block_filter: Option<String>,
    pub version: bool,
}

This structure holds the command-line-options and is populated by docopt. See man-page and the output of --list-encodings and --help for more information about their meaning.

Fields

ascii_filter: Option<String>

filter applied after decoding (see --list-encodings for AF examples)

no_metadata: bool

never print byte-counter, encoding or filter

debug_option: bool

show how command-line-options are interpreted

inputs: Vec<PathBuf>

paths to files to scan (or - for stdin)

encoding: Vec<String>

set (multiple) encodings to search for

grep_char: Option<String>

grep for characters with ASCII-code in output lines

list_encodings: bool

list predefined encoding and filter names for ENC

chars_min: Option<String>

minimum characters of printed strings

same_unicode_block: bool

require chars in finding to be in the same Unicode-block

output: Option<PathBuf>

print not to stdout but in file

output_line_len: Option<String>

output line length in Unicode-codepoints

counter_offset: Option<String>

start counting input bytes with NUM

radix: Option<Radix>

unicode_block_filter: Option<String>

filter applied after decoding (see --list-encodings for UBF examples)

version: bool

print version and exit

Trait Implementations

impl Debug for Args

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

Formats the value using the given formatter.

impl PartialEq<Args> for Args

fn eq(&self, other: &Args) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Args) -> bool

This method tests for !=.

impl StructOpt for Args

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by [StructOpt::clap] called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

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

Builds the struct from the command line arguments (std::env::args_os). Unlike [StructOpt::from_args], returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructuralPartialEq for Args