Struct Opt

pub struct Opt {

    pub thread: usize,
    pub output: PathBuf,
    pub dir: PathBuf,
    pub stat: bool,
    pub list: Option<String>,
    pub bin_ctags: PathBuf,
    pub bin_git: PathBuf,
    pub opt_ctags: Vec<String>,
    pub opt_git: Vec<String>,
    pub opt_git_lfs: Vec<String>,
    pub verbose: bool,
    pub exclude_lfs: bool,
    pub include_untracked: bool,
    pub include_ignored: bool,
    pub include_submodule: bool,
    pub validate_utf8: bool,
    pub unsorted: bool,
    pub fields: Option<String>,
    pub languages: Option<String>,
    pub exclude: Vec<String>,
    pub completion: Option<String>,
    pub config: bool,
}

Fields

thread: usize

Number of threads

output: PathBuf

Output filename ( filename ‘-’ means output to stdout )

dir: PathBuf

Search directory

stat: bool

Show statistics

list: Option<String>

Filename of input file list

bin_ctags: PathBuf

Path to ctags binary

bin_git: PathBuf

Path to git binary

opt_ctags: Vec<String>

Options passed to ctags

opt_git: Vec<String>

Options passed to git

opt_git_lfs: Vec<String>

Options passed to git-lfs

verbose: bool

Verbose mode

exclude_lfs: bool

Exclude git-lfs tracked files

include_untracked: bool

Include untracked files

include_ignored: bool

Include ignored files

include_submodule: bool

Include submodule files

validate_utf8: bool

Validate UTF8 sequence of tag file

unsorted: bool

Disable tags sort

fields: Option<String>

Disable tags sort

languages: Option<String>

Languages

exclude: Vec<String>

Glob pattern of exclude file ( ex. –exclude ‘*.rs’ )

completion: Option<String>

Generate shell completion file

config: bool

Generate configuration sample file

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() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Opt

where Opt: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Opt

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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.

impl StructOptToml for Opt

fn merge<'a>(from_toml: Self, from_args: Self, args: &ArgMatches<'_>) -> Self

where Self: Sized + StructOpt + Deserialize<'a>,

Merge the struct from TOML and the struct from args

fn from_clap_with_toml<'a>( toml_str: &'a str, args: &ArgMatches<'_>, ) -> Result<Self, Error>

where Self: Sized + StructOpt + Deserialize<'a>,

Creates the struct from clap::ArgMatches with initial values from TOML.

fn from_args_with_toml<'a>(toml_str: &'a str) -> Result<Self, Error>

where Self: Sized + StructOpt + Deserialize<'a>,

Creates the struct from command line arguments with initial values from TOML.

fn from_iter_with_toml<'a, I>(toml_str: &'a str, iter: I) -> Result<Self, Error>

where Self: Sized + StructOpt + Deserialize<'a>, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Creates the struct from iterator with initial values from TOML.