Trait git_checks_core::Content

source · 
pub trait Content {
    // Required methods
    fn workarea(&self, ctx: &GitContext) -> Result<GitWorkArea, WorkAreaError>;
    fn sha1(&self) -> Option<&CommitId>;
    fn diffs(&self) -> &Vec<DiffInfo>;
    fn path_diff(&self, path: &FileName) -> Result<String, CommitError>;

    // Provided method
    fn modified_files(&self) -> Vec<&FileName> { ... }
}
Expand description

A trait for representing the content of a diff.

This may be used for checks which do not require any metadata.

Required Methods§

source

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

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

source

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

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

source

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

The differences in the content.

source

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

Get the patch difference for the given path.

Provided Methods§

source

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

Return a vector of files modified in a diff.

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

Implementors§