Struct git_checks_core::GitCheckConfiguration

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

Configuration for checks to run against a repository.

Implementations

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, RunError>

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, RunError>

where R: AsRef<str>,

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

Trait Implementations

impl<'a> Clone for GitCheckConfiguration<'a>

fn clone(&self) -> GitCheckConfiguration<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> GitCheckConfiguration<'a>

Returns the “default value” for a type.