Struct CheckOptions

pub struct CheckOptions {
    pub allow_dirty: bool,
    pub allow_no_vcs: bool,
    pub allow_staged: bool,
}

Stores the options available for calling check_version_control and controls which checks if any are run

Fields

allow_dirty: bool

Does not return an error for dirty files nor generate the list of said files

allow_no_vcs: bool

This option basically disables checking. If true no checks are done. (Not even if the path exists)

allow_staged: bool

Does not return an error for staged files nor generate the list of said files

Implementations

impl CheckOptions

pub fn new() -> Self

Creates a CheckOptions with default values

Trait Implementations

impl Clone for CheckOptions

fn clone(&self) -> CheckOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckOptions

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

Formats the value using the given formatter.

impl Default for CheckOptions

fn default() -> CheckOptions

Returns the “default value” for a type.

impl Hash for CheckOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CheckOptions

fn cmp(&self, other: &CheckOptions) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CheckOptions

fn eq(&self, other: &CheckOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CheckOptions

fn partial_cmp(&self, other: &CheckOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for CheckOptions

impl Eq for CheckOptions

impl StructuralPartialEq for CheckOptions