Struct globset::GlobSet

pub struct GlobSet { /* private fields */ }

GlobSet represents a group of globs that can be matched together in a single pass.

Implementations

impl GlobSet

pub fn builder() -> GlobSetBuilder

Create a new GlobSetBuilder. A GlobSetBuilder can be used to add new patterns. Once all patterns have been added, build should be called to produce a GlobSet, which can then be used for matching.

pub fn empty() -> GlobSet

Create an empty GlobSet. An empty set matches nothing.

pub fn is_empty(&self) -> bool

Returns true if this set is empty, and therefore matches nothing.

pub fn len(&self) -> usize

Returns the number of globs in this set.

pub fn is_match<P: AsRef<Path>>(&self, path: P) -> bool

Returns true if any glob in this set matches the path given.

pub fn is_match_candidate(&self, path: &Candidate<'_>) -> bool

Returns true if any glob in this set matches the path given.

This takes a Candidate as input, which can be used to amortize the cost of preparing a path for matching.

pub fn matches<P: AsRef<Path>>(&self, path: P) -> Vec<usize>

Returns the sequence number of every glob pattern that matches the given path.

pub fn matches_candidate(&self, path: &Candidate<'_>) -> Vec<usize>

Returns the sequence number of every glob pattern that matches the given path.

This takes a Candidate as input, which can be used to amortize the cost of preparing a path for matching.

pub fn matches_into<P: AsRef<Path>>(&self, path: P, into: &mut Vec<usize>)

Adds the sequence number of every glob pattern that matches the given path to the vec given.

into is cleared before matching begins, and contains the set of sequence numbers (in ascending order) after matching ends. If no globs were matched, then into will be empty.

pub fn matches_candidate_into( &self, path: &Candidate<'_>, into: &mut Vec<usize> )

Adds the sequence number of every glob pattern that matches the given path to the vec given.

into is cleared before matching begins, and contains the set of sequence numbers (in ascending order) after matching ends. If no globs were matched, then into will be empty.

This takes a Candidate as input, which can be used to amortize the cost of preparing a path for matching.

Trait Implementations

impl Clone for GlobSet

fn clone(&self) -> GlobSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobSet

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

Formats the value using the given formatter.

impl Default for GlobSet

fn default() -> Self

Create a default empty GlobSet.