Struct git_checks::Topic

pub struct Topic {
    pub base: CommitId,
    pub sha1: CommitId,
    pub diffs: Vec<DiffInfo>,
    // some fields omitted
}

Representation of a topic with information useful for commit checks.

Fields

base: CommitId

The SHA1 of the base commit.

sha1: CommitId

The SHA1 of the commit.

diffs: Vec<DiffInfo>

Information about files that changed in this commit.

Methods

impl Topic

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

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

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

Get the patch difference for the given path.

Trait Implementations

impl Content for Topic

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.

impl Debug for Topic

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

Formats the value using the given formatter.