Struct git_checks::GitCheckConfiguration

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

Configuration for checks to run against a repository.

Methods

impl<'a> GitCheckConfiguration<'a>

fn new() -> Self

Create a new check configuration.

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

Add a check to be run on every commit.

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

Add a check to be once for the entire branch.

fn list(&self,
        ctx: &GitContext,
        reason: &str,
        base_branch: &CommitId,
        topic: &CommitId)
        -> Result<Vec<CommitId>>

Find refs that should be checked given a target branch and the topic names.

fn run(&self,
       ctx: &GitContext,
       refs: &[CommitId],
       topic_owner: &Identity)
       -> Result<CheckResult>

Run checks over all refs and collect results from the checks.

fn run_topic<R>(&self,
                ctx: &GitContext,
                reason: R,
                base_branch: &CommitId,
                topic: &CommitId,
                owner: &Identity)
                -> Result<CheckResult> 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.