Skip to main content

GlobSet

Struct GlobSet 

Source
pub struct GlobSet { /* private fields */ }
Expand description

A set of glob patterns that can be matched against paths efficiently.

GlobSet classifies each pattern at build time into the fastest applicable strategy (extension hash, literal, prefix, suffix) and only falls back to the full glob_match engine for patterns that need it.

§Example

use glob_set::{Glob, GlobSet, GlobSetBuilder};

let mut builder = GlobSetBuilder::new();
builder.add(Glob::new("*.rs").unwrap());
builder.add(Glob::new("*.toml").unwrap());
let set = builder.build().unwrap();

assert!(set.is_match("foo.rs"));
assert!(set.is_match("Cargo.toml"));
assert!(!set.is_match("foo.js"));

Implementations§

Source§

impl GlobSet

Source

pub fn len(&self) -> usize

Return the number of patterns in this set.

Source

pub fn is_empty(&self) -> bool

Return whether this set is empty.

Source

pub fn is_match(&self, path: impl AsRef<str>) -> bool

Test whether any pattern matches the given path.

Source

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

Test whether any pattern matches the given candidate.

Source

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

Return the indices of all patterns that match the given path.

Source

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

Append the indices of all matching patterns to into.

Source

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

Return the indices of all patterns that match the given candidate.

Source

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

Append the indices of all matching patterns for the given candidate to into.

Trait Implementations§

Source§

impl Clone for GlobSet

Source§

fn clone(&self) -> GlobSet

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GlobSet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GlobSet

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.