Struct git_checks::GitCheckConfiguration

pub struct GitCheckConfiguration<'a> { /* fields omitted */ }

Configuration for checks to run against a repository.

Methods

impl<'a> GitCheckConfiguration<'a>

pub fn new() -> Self

Create a new check configuration.

pub fn add_check(&mut self, check: &'a dyn Check) -> &mut Self

Add a check to be run on every commit.

pub fn add_branch_check(&mut self, check: &'a dyn BranchCheck) -> &mut Self

Add a check to be once for the entire branch.

pub fn add_topic_check(&mut self, check: &'a dyn TopicCheck) -> &mut Self

Add a check to be once for the entire topic.

pub fn run_commit(
    &self,
    ctx: &GitContext,
    commit: &CommitId,
    owner: &Identity
) -> Result<CheckResult>

Run checks over a given commit.

pub fn run_topic<R>(
    &self,
    ctx: &GitContext,
    reason: R,
    base_branch: &CommitId,
    topic: &CommitId,
    owner: &Identity
) -> Result<TopicCheckResult> where
    R: AsRef<str>, 

Run checks over a given topic and collect results from the checks.

Trait Implementations

impl<'a> Default for GitCheckConfiguration<'a>

fn default() -> GitCheckConfiguration<'a>

Returns the "default value" for a type.

impl<'a> Debug for GitCheckConfiguration<'a>

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

Formats the value using the given formatter.