Struct Opt

pub struct Opt {
    pub version: bool,
    pub to_code: String,
    pub output: Option<PathBuf>,
    pub list: bool,
    pub non_text_threshold: u8,
    pub non_ascii_to_guess: usize,
    pub show: bool,
    pub quiet: bool,
    pub paths: Vec<PathBuf>,
}

Converts texts from the auto-detected encoding to UTF-8 or a specified encoding. If byte sequences that is malformed as Unicode are found, they are replaced with the REPLACEMENT CHARACTER(U+FFFD). If the destination encoding is not Unicode and unmappable characters are found, they are replaced with the corresponding numeric character references. If the encoding detection is considered it failed, the input texts are output as-is, meaning no conversion takes place, and an error message is emitted.

Fields

version: bool

Prints version information.

to_code: String

The encoding of the output.

output: Option<PathBuf>

Output directory. If input arguments contain directories, the directory hierarchies are preserved under DIRECTORY.

list: bool

Prints supported encodings.

non_text_threshold: u8

The threshold (0-100) of non-text character occurrence. Above this threshold in decoded UTF-8 texts, the encoding detection is treated as it failed. In that case the input texts are output as-is with an error message emitted.

non_ascii_to_guess: usize

The number of non-ASCII characters to guess the encoding. Around 100 characters are enough for most cases, but if the guess is not accurate, increasing the value might help.

show: bool

Only shows auto-detected encodings without decoded texts.

quiet: bool

Suppresses error messages when encoding detection failed.

paths: Vec<PathBuf>

Files (or directories) to process

Implementations

impl Opt

pub fn new() -> Self

Trait Implementations

impl Debug for Opt

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

Formats the value using the given formatter.

impl Default for Opt

fn default() -> Opt

Returns the “default value” for a type.

impl StructOpt for Opt

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

where Self: Sized,

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>

where Self: Sized,

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 Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + 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 Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

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