Struct git_checks_core::Commit

pub struct Commit {
    pub sha1: CommitId,
    pub message: String,
    pub parents: Vec<CommitId>,
    pub diffs: Vec<DiffInfo>,
    pub author: Identity,
    pub committer: Identity,
    /* private fields */
}

Representation of a commit with information useful for commit checks.

Fields

sha1: CommitId

The SHA1 of the commit.

message: String

The commit message.

parents: Vec<CommitId>

The parents of the commit.

diffs: Vec<DiffInfo>

Information about files that changed in this commit.

author: Identity

The identity of the author.

committer: Identity

The identity of the commiter.

Implementations

impl Commit

pub fn new(ctx: &GitContext, sha1: &CommitId) -> Result<Self, CommitError>

Create a new commit from the given context for the SHA1.

pub fn file_patch<P>(&self, path: P) -> Result<String, CommitError>

where P: AsRef<OsStr>,

Get the patch difference for the given path.

Trait Implementations

impl Content for Commit

fn workarea(&self, ctx: &GitContext) -> Result<GitWorkArea, WorkAreaError>

A workarea which may be used to work on the content.

fn sha1(&self) -> Option<&CommitId>

The SHA1 of the commit (if the content is of a commit).

fn diffs(&self) -> &Vec<DiffInfo>

The differences in the content.

fn path_diff(&self, path: &FileName) -> Result<String, CommitError>

Get the patch difference for the given path.

fn modified_files(&self) -> Vec<&FileName>

Return a vector of files modified in a diff.

impl Debug for Commit

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

Formats the value using the given formatter.