Struct git_checks::Commit

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

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.

Methods

impl Commit

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

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

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

Deprecated since 2.3.0

: please use the Content::modified_files trait method instead

Return a vector of files changed by the commit.

This excludes paths which are either not actually files (e.g., submodules and symlinks), as well as paths which were deleted in this commit.

fn file_patch<P>(&self, path: P) -> Result<String> where
    P: AsRef<OsStr>, 

Get the patch difference for the given path.

Trait Implementations

impl Debug for Commit

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Content for Commit

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

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>

Get the patch difference for the given path.

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

Return a vector of files modified in a diff.