Struct Args 

pub struct Args {
    pub allow_empty: bool,
    pub commit_type: Option<String>,
    pub scope: Option<String>,
    pub message: Option<String>,
    pub breaking: bool,
    pub breaking_message: Option<String>,
    pub body: Option<String>,
    pub footer: Vec<String>,
}

Fields

allow_empty: bool

Allow committing with no staged changes

commit_type: Option<String>

Conventional Commit type (feat, fix, etc.)

scope: Option<String>

Commit Scope (Optional)

message: Option<String>

Commit Short Summary (72 chars)

breaking: bool

Breaking Change Boolean

breaking_message: Option<String>

Breaking Change Message (Optional)

body: Option<String>

Commit Message Body (Optional)

footer: Vec<String>

Commit Message Footer (can be stacked with -f “Author: Wizard” -f “Co-Author: Cat”)

Trait Implementations

impl Args for Args

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 Clone for Args

fn clone(&self) -> Args

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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.