Struct git_cliff::args::Opt

pub struct Opt {

    pub verbose: u8,
    pub config: PathBuf,
    pub workdir: Option<PathBuf>,
    pub repository: Option<PathBuf>,
    pub prepend: Option<PathBuf>,
    pub output: Option<PathBuf>,
    pub tag: Option<String>,
    pub body: Option<String>,
    pub init: bool,
    pub latest: bool,
    pub unreleased: bool,
    pub strip: Option<String>,
    pub range: Option<String>,
}

Command-line arguments to parse.

Fields

verbose: u8

Increases the logging verbosity.

config: PathBuf

Sets the configuration file.

workdir: Option<PathBuf>

Sets the working directory.

repository: Option<PathBuf>

Sets the repository to parse commits from.

prepend: Option<PathBuf>

Prepends entries to the given changelog file.

output: Option<PathBuf>

Writes output to the given file.

tag: Option<String>

Sets the tag for the latest version.

body: Option<String>

Sets the template for the changelog body.

init: bool

Writes the default configuration file to cliff.toml

latest: bool

Processes the commits starting from the latest tag.

unreleased: bool

Processes the commits that do not belong to a tag.

strip: Option<String>

Strips the given parts from the changelog.

range: Option<String>

Sets the commit range to process.

Trait Implementations

impl Debug for Opt

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

Formats the value using the given formatter.

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

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.