Skip to main content

Check

Trait Check 

Source
pub trait Check: Sync {
    // Required methods
    fn name(&self) -> &str;
    fn stage(&self) -> Stage;
    fn scope(&self) -> Scope;
    fn severity(&self) -> Severity;
    fn run(&self, ctx: &Ctx<'_>) -> Outcome;

    // Provided method
    fn fix(&self) -> Fix { ... }
}
Expand description

One check, whether compiled in or declared by the repository.

Sync because pre-commit hands every check to its own thread. Both implementations satisfy it for free, and requiring it here is what lets the dispatcher hold &'static dyn Check without caring which kind it has.

Required Methods§

Source

fn name(&self) -> &str

Source

fn stage(&self) -> Stage

Source

fn scope(&self) -> Scope

Source

fn severity(&self) -> Severity

Source

fn run(&self, ctx: &Ctx<'_>) -> Outcome

Provided Methods§

Source

fn fix(&self) -> Fix

Whether this check can repair what it finds. None for almost all.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§