Struct watchexec::filter::tagged::Filter

pub struct Filter {
    pub in_path: Option<PathBuf>,
    pub on: Matcher,
    pub op: Op,
    pub pat: Pattern,
    pub negate: bool,
}

A tagged filter.

Fields

in_path: Option<PathBuf>

Path the filter applies from.

on: Matcher

Which tag the filter applies to.

op: Op

The operation to perform on the tag’s value.

pat: Pattern

The pattern to match against the tag’s value.

negate: bool

If true, a positive match with this filter will override negative matches from previous filters on the same tag, and negative matches will be ignored.

Implementations

impl Filter

pub fn matches(
    &self,
    subject: impl AsRef<str>
) -> Result<bool, TaggedFiltererError>

Matches the filter against a subject.

This is really an internal method to the tagged filterer machinery, exposed so you can build your own filterer using the same types or the textual syntax. As such its behaviour is not guaranteed to be stable (its signature is, though).

pub fn from_glob_ignore(in_path: Option<PathBuf>, glob: &str) -> Self

Create a filter from a gitignore-style glob pattern.

The optional path is for the in_path field of the filter. When parsing gitignore files, it should be set to the path of the directory the ignore file is in.

The resulting filter matches on Path, with the NotGlob op, and a Glob pattern. If it starts with a !, it is negated.

pub fn canonicalised(self) -> Result<Self, TaggedFiltererError>

Returns the filter with its in_path canonicalised.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl FromStr for Filter

type Err = TaggedFiltererError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Filter> for Filter

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

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

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

This method tests for !=.

impl Eq for Filter

impl StructuralEq for Filter

impl StructuralPartialEq for Filter