Struct Opt

pub struct Opt {

    pub help: Option<bool>,
    pub version: Option<bool>,
    pub verbose: u8,
    pub init: Option<Option<String>>,
    pub config: PathBuf,
    pub config_url: Option<Url>,
    pub workdir: Option<PathBuf>,
    pub repository: Option<Vec<PathBuf>>,
    pub include_path: Option<Vec<Pattern>>,
    pub exclude_path: Option<Vec<Pattern>>,
    pub tag_pattern: Option<Regex>,
    pub with_commit: Option<Vec<String>>,
    pub with_tag_message: Option<String>,
    pub ignore_tags: Option<Regex>,
    pub count_tags: Option<Regex>,
    pub skip_commit: Option<Vec<String>>,
    pub prepend: Option<PathBuf>,
    pub output: Option<PathBuf>,
    pub tag: Option<String>,
    pub bump: Option<BumpOption>,
    pub bumped_version: bool,
    pub body: Option<String>,
    pub latest: bool,
    pub current: bool,
    pub unreleased: bool,
    pub topo_order: bool,
    pub use_branch_tags: bool,
    pub no_exec: bool,
    pub context: bool,
    pub from_context: Option<PathBuf>,
    pub strip: Option<Strip>,
    pub sort: Sort,
    pub range: Option<String>,
    pub github_token: Option<SecretString>,
    pub github_repo: Option<RemoteValue>,
    pub gitlab_token: Option<SecretString>,
    pub gitlab_repo: Option<RemoteValue>,
    pub gitea_token: Option<SecretString>,
    pub gitea_repo: Option<RemoteValue>,
    pub bitbucket_token: Option<SecretString>,
    pub bitbucket_repo: Option<RemoteValue>,
    pub use_native_tls: bool,
}

Command-line arguments to parse.

Fields

help: Option<bool>

version: Option<bool>

verbose: u8

Increases the logging verbosity.

init: Option<Option<String>>

Writes the default configuration file to cliff.toml

config: PathBuf

Sets the configuration file.

config_url: Option<Url>

Sets the URL for the configuration file.

workdir: Option<PathBuf>

Sets the working directory.

repository: Option<Vec<PathBuf>>

Sets the git repository.

include_path: Option<Vec<Pattern>>

Sets the path to include related commits.

exclude_path: Option<Vec<Pattern>>

Sets the path to exclude related commits.

tag_pattern: Option<Regex>

Sets the regex for matching git tags.

with_commit: Option<Vec<String>>

Sets custom commit messages to include in the changelog.

with_tag_message: Option<String>

Sets custom message for the latest release.

ignore_tags: Option<Regex>

Sets the tags to ignore in the changelog.

count_tags: Option<Regex>

Sets the tags to count in the changelog.

skip_commit: Option<Vec<String>>

Sets commits that will be skipped in the changelog.

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.

bump: Option<BumpOption>

Bumps the version for unreleased changes. Optionally with specified version.

bumped_version: bool

Prints bumped version for unreleased changes.

body: Option<String>

Sets the template for the changelog body.

latest: bool

Processes the commits starting from the latest tag.

current: bool

Processes the commits that belong to the current tag.

unreleased: bool

Processes the commits that do not belong to a tag.

topo_order: bool

Sorts the tags topologically.

use_branch_tags: bool

Include only the tags that belong to the current branch.

no_exec: bool

Disables the external command execution.

context: bool

Prints changelog context as JSON.

from_context: Option<PathBuf>

Generates changelog from a JSON context.

strip: Option<Strip>

Strips the given parts from the changelog.

sort: Sort

Sets sorting of the commits inside sections.

range: Option<String>

Sets the commit range to process.

github_token: Option<SecretString>

Sets the GitHub API token.

github_repo: Option<RemoteValue>

Sets the GitHub repository.

gitlab_token: Option<SecretString>

Sets the GitLab API token.

gitlab_repo: Option<RemoteValue>

Sets the GitLab repository.

gitea_token: Option<SecretString>

Sets the Gitea API token.

gitea_repo: Option<RemoteValue>

Sets the Gitea repository.

bitbucket_token: Option<SecretString>

Sets the Bitbucket API token.

bitbucket_repo: Option<RemoteValue>

Sets the Bitbucket repository.

use_native_tls: bool

Load TLS certificates from the native certificate store.

Trait Implementations

impl Args for Opt

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 Opt

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 Debug for Opt

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

Formats the value using the given formatter.

impl FromArgMatches for Opt

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 Opt

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.