Struct file_source::paths_provider::glob::MatchOptions

pub struct MatchOptions {
    pub case_sensitive: bool,
    pub require_literal_separator: bool,
    pub require_literal_leading_dot: bool,
}

Configuration options to modify the behaviour of Pattern::matches_with(..).

Fields

case_sensitive: bool

Whether or not patterns should be matched in a case-sensitive manner. This currently only considers upper/lower case relationships between ASCII characters, but in future this might be extended to work with Unicode.

require_literal_separator: bool

Whether or not path-component separator characters (e.g. / on Posix) must be matched by a literal /, rather than by * or ? or [...].

require_literal_leading_dot: bool

Whether or not paths that contain components that start with a . will require that . appears literally in the pattern; *, ?, **, or [...] will not match. This is useful because such files are conventionally considered hidden on Unix systems and it might be desirable to skip them when listing files.

Implementations

impl MatchOptions

pub fn new() -> MatchOptions

Constructs a new MatchOptions with default field values. This is used when calling functions that do not take an explicit MatchOptions parameter.

This function always returns this value:

MatchOptions {
    case_sensitive: true,
    require_literal_separator: false,
    require_literal_leading_dot: false
}

Note

The behavior of this method doesn’t match default()’s. This returns case_sensitive as true while default() does it as false.

Trait Implementations

impl Clone for MatchOptions

fn clone(&self) -> MatchOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MatchOptions

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

Formats the value using the given formatter.

impl Default for MatchOptions

fn default() -> MatchOptions

Returns the “default value” for a type.

impl Hash for MatchOptions

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

where __H: Hasher,

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 MatchOptions

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

Restrict a value to a certain interval.

impl PartialEq for MatchOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for MatchOptions

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for MatchOptions

impl Eq for MatchOptions

impl StructuralPartialEq for MatchOptions