Struct Defaults

pub struct Defaults {
    pub signature: MagicSignature,
    pub search_mode: SearchMode,
    pub literal: bool,
}

Default settings for some fields of a Pattern.

These can be used to represent GIT_*_PATHSPECS environment variables, for example.

Fields

signature: MagicSignature

The default signature.

search_mode: SearchMode

The default search-mode.

Note that even if it’s SearchMode::Literal, the pathspecs will be parsed as usual, but matched verbatim afterwards.

Note that pathspecs can override this the SearchMode::Literal variant with an explicit :(glob) prefix.

literal: bool

If set, the pathspec will not be parsed but used verbatim. Implies SearchMode::Literal for search_mode.

Implementations

impl Defaults

pub fn from_environment( var: &mut dyn FnMut(&str) -> Option<OsString>, ) -> Result<Self, Error>

Initialize this instance using information from the environment as per the official documentation (look for PATHSPECS), calling var(variable_name) for each variable that should be obtained.

Used environment variables are GIT_GLOB_PATHSPECS, GIT_NOGLOB_PATHSPECS, GIT_LITERAL_PATHSPECS and GIT_ICASE_PATHSPECS. Note that there are lot of failure modes, and instead of offering lenient parsing, the caller may ignore errors and use other defaults instead.

Deviation

Instead of failing if GIT_LITERAL_PATHSPECS is used with glob globals, we ignore these. Also our implementation allows global icase settings in combination with this setting.

Trait Implementations

impl Clone for Defaults

fn clone(&self) -> Defaults

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Defaults

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

Formats the value using the given formatter.

impl Default for Defaults

fn default() -> Defaults

Returns the “default value” for a type.

impl Ord for Defaults

fn cmp(&self, other: &Defaults) -> 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 Defaults

fn eq(&self, other: &Defaults) -> 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 Defaults

fn partial_cmp(&self, other: &Defaults) -> 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 Defaults

impl Eq for Defaults

impl StructuralPartialEq for Defaults