Struct supergit::Commit

pub struct Commit {
    pub id: HashId,
    // some fields omitted
}

Represent a commit on a repository

When creating a commit object, it is guaranteed that it exists in the repository.

Fields

id: HashId

Implementations

impl Commit

pub fn id_str(&self) -> String

Get a utf-8 string representation of the commit ID

pub fn summary(&self) -> String

Get the summary line as a utf-8 string

pub fn parent_count(&self) -> usize

Get the number of parents

pub fn first_parent(&self) -> Option<Self>

Return the first parent, if it exists

pub fn parent(&self, num: usize) -> Option<Self>

Get a specific parent, if it exists

pub fn parents(&self) -> Vec<Commit>

Get the set of parents as a vector

Use this function if you suspect a commit has more than one parent.

pub fn tree(&self) -> FileTree

Get the file tree for this commit

pub fn get_paths(&self) -> Vec<String>

Get the list of paths in the repository touched by this commit

Using this function directly is often not what you want. Instead, use the get_history(...) function on FileTree, which uses this function.

Trait Implementations

impl Clone for Commit

pub fn clone(&self) -> Commit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Commit

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

Formats the value using the given formatter.