Struct git_checks::checks::RestrictedPath

pub struct RestrictedPath { /* fields omitted */ }

A check which denies commits which modify files underneath certain path.

Methods

impl RestrictedPath

pub fn new<S: ToString>(path: S) -> Self

Create a check which rejects modifications to files underneath a of given path.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn required(&mut self, required: bool) -> &mut Self

Whether commits changing the path are errors or warnings.

Trait Implementations

impl Debug for RestrictedPath

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

Formats the value using the given formatter.

impl ContentCheck for RestrictedPath

fn name(&self) -> &str

The name of the check.

fn check(&self, _: &CheckGitContext, content: &Content) -> Result<CheckResult>

Run the check.