Struct git_checks::checks::ValidName

pub struct ValidName { /* fields omitted */ }

A check which checks for valid identities.

This check uses the host external binary to check the validity of domain names used in email addresses.

The check can be configured with a policy on how to enforce use of full names.

Methods

impl ValidName

pub fn new() -> Self

Create a new check to check identities.

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 set_full_name_policy(     &mut self,     policy: ValidNameFullNamePolicy ) -> &mut Self

Set policy for enforcement of use of full names.

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 whitelist_domains<I, D>(&mut self, domains: I) -> &mut Self where     I: IntoIterator<Item = D>,     D: ToString,

Add domains to the domain whitelist.

Trait Implementations

impl Debug for ValidName

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

Formats the value using the given formatter.

impl Default for ValidName

fn default() -> Self

Returns the "default value" for a type.

impl Clone for ValidName

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Check for ValidName

fn name(&self) -> &str

The name of the check.

fn check(&self, _: &CheckGitContext, commit: &Commit) -> Result<CheckResult>

Run the check.

impl BranchCheck for ValidName

fn name(&self) -> &str

The name of the check.

fn check(&self, ctx: &CheckGitContext, _: &CommitId) -> Result<CheckResult>

Run the check.