Struct Commit 

pub struct Commit<'a> { /* private fields */ }

Builder for git commit command.

See git commit --help for full documentation.

Implementations

impl<'a> Commit<'a>

pub fn repo_path(self, path: &'a Path) -> Self

Set the repository path (-C <path>).

impl<'a> Commit<'a>

pub fn porcelain(self) -> Self

Give output in machine-parseable format.

Corresponds to --porcelain.

pub fn porcelain_if(self, value: bool) -> Self

Conditionally enable porcelain output.

impl<'a> Commit<'a>

pub fn message(self, message: &'a str) -> Self

Set the commit message.

Corresponds to --message or -m.

pub fn author(self, author: &'a str) -> Self

Set the commit author.

Corresponds to --author. Format: Name <email>.

pub fn date(self, date: &'a str) -> Self

Set the author date.

Corresponds to --date.

pub fn allow_empty(self) -> Self

Allow creating a commit with no changes.

Corresponds to --allow-empty.

pub fn allow_empty_if(self, value: bool) -> Self

Conditionally allow creating a commit with no changes.

pub fn allow_empty_message(self) -> Self

Allow creating a commit with an empty message.

Corresponds to --allow-empty-message.

pub fn allow_empty_message_if(self, value: bool) -> Self

Conditionally allow creating a commit with an empty message.

pub fn env(self, key: EnvVariableName<'a>, value: &'a OsStr) -> Self

Set an environment variable for the command.

pub async fn status(self) -> Result<(), CommandError>

Execute the command and return the exit status.

Trait Implementations

impl Build for Commit<'_>

fn build(self) -> Command

Build the command without executing it.

impl<'a> Debug for Commit<'a>

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

Formats the value using the given formatter.

impl Default for Commit<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Porcelain for Commit<'a>

fn porcelain_if(self, value: bool) -> Self

Conditionally enable porcelain output (--porcelain).

fn porcelain(self) -> Self

Enable porcelain output (--porcelain).

impl<'a> RepoPath<'a> for Commit<'a>

fn repo_path(self, path: &'a Path) -> Self

Set the repository path (-C <path>).