Struct git_checks_core::impl_prelude::CheckResult

pub struct CheckResult { /* private fields */ }

The results of a check.

Implementations

impl CheckResult

pub fn new() -> Self

Create a new results structure.

pub fn add_message<S>(&mut self, severity: Severity, message: S) -> &mut Self where
    S: Into<String>, 

Add a message to the result.

pub fn add_warning<S: Into<String>>(&mut self, warning: S) -> &mut Self

Adds a warning message to the results.

pub fn add_alert<S: Into<String>>(
    &mut self,
    alert: S,
    should_block: bool
) -> &mut Self

Adds an alert to the results.

These messages should be brought to the attention of those maintaining the deployment of the checks.

pub fn add_error<S: Into<String>>(&mut self, error: S) -> &mut Self

Adds a error message to the results.

Also marks the checks as having failed.

pub fn make_temporary(&mut self) -> &mut Self

Indicates that there are messages which may be temporary.

pub fn whitelist(&mut self) -> &mut Self

Allows the checks to pass no matter what.

pub fn warnings(&self) -> &Vec<String>

The warnings from the checks.

pub fn alerts(&self) -> &Vec<String>

The alerts from the checks.

pub fn errors(&self) -> &Vec<String>

The errors from the checks.

pub fn temporary(&self) -> bool

Whether there are temporary messages or not.

pub fn allowed(&self) -> bool

Whether the checks will allow the commit no matter what.

pub fn pass(&self) -> bool

Whether the checks passed or failed.

pub fn combine(self, other: Self) -> Self

Combine two results together.

Trait Implementations

impl Debug for CheckResult

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

Formats the value using the given formatter.

impl Default for CheckResult

fn default() -> CheckResult

Returns the “default value” for a type.