Struct Commit

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

Represents a commit object in the Git object database.

Implementations

impl<'repo> Commit<'repo>

pub fn get_oid(&self) -> NonZeroOid

Get the object ID of the commit.

pub fn get_short_oid(&self) -> Result<String>

Get the short object ID of the commit.

pub fn get_parent_oids(&self) -> Vec<NonZeroOid>

Get the object IDs of the parents of this commit.

pub fn get_only_parent_oid(&self) -> Option<NonZeroOid>

Get the parent OID of this commit if there is exactly one parent, or None otherwise.

pub fn get_parent_count(&self) -> usize

Get the number of parents of this commit.

pub fn get_parents(&self) -> Vec<Commit<'repo>>

Get the parent commits of this commit.

pub fn get_only_parent(&self) -> Option<Commit<'repo>>

Get the parent of this commit if there is exactly one parent, or None otherwise.

pub fn get_time(&self) -> Time

Get the commit time of this commit.

pub fn get_summary(&self) -> Result<BString>

Get the summary (first line) of the commit message.

pub fn get_message_pretty(&self) -> BString

Get the commit message with some whitespace trimmed.

pub fn get_message_raw(&self) -> BString

Get the commit message, without any whitespace trimmed.

pub fn get_author(&self) -> Signature<'_>

Get the author of this commit.

pub fn get_committer(&self) -> Signature<'_>

Get the committer of this commit.

pub fn get_tree_oid(&self) -> MaybeZeroOid

Get the OID of the Tree object associated with this commit.

pub fn get_tree(&self) -> Result<Tree<'_>>

Get the Tree object associated with this commit.

pub fn get_trailers(&self) -> Result<Vec<(String, String)>>

Get the “trailer” metadata from this commit’s message. These are strings like Signed-off-by: foo which appear at the end of the commit message.

pub fn friendly_describe(&self, glyphs: &Glyphs) -> Result<StyledString>

Print a one-line description of this commit containing its OID and summary.

pub fn friendly_describe_oid(&self, glyphs: &Glyphs) -> Result<StyledString>

Print a shortened colorized version of the OID of this commit.

pub fn friendly_preview(&self) -> Result<StyledString>

Get a multi-line description of this commit containing information about its OID, author, commit time, and message.

pub fn is_empty(&self) -> bool

Determine if the current commit is empty (has no changes compared to its parent).

pub fn contains_touched_path(&self, path: &Path) -> Result<Option<bool>>

Determine if this commit added, removed, or changed the entry at the provided file path.

pub fn amend_commit( &self, update_ref: Option<&str>, author: Option<&Signature<'_>>, committer: Option<&Signature<'_>>, message: Option<&str>, tree: Option<&Tree<'_>>, ) -> Result<NonZeroOid>

Amend this existing commit. Returns the OID of the resulting new commit.

Trait Implementations

impl<'repo> Clone for Commit<'repo>

fn clone(&self) -> Commit<'repo>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'repo> Debug for Commit<'repo>

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

Formats the value using the given formatter.