Struct SearchRequest 

pub struct SearchRequest {
    pub root: PathBuf,
    pub patterns: Vec<String>,
    pub exclude_patterns: Vec<String>,
    pub options: ListOptions,
    pub cache: CachePolicy,
}

Available on crate feature search only.

Request for a glob-based search.

Fields

root: PathBuf

Root directory to search.

patterns: Vec<String>

Include glob patterns (matched against paths relative to root).

exclude_patterns: Vec<String>

Optional exclude patterns.

options: ListOptions

Listing / traversal options.

cache: CachePolicy

Cache policy for this request.

Caching only occurs when an explicit DiscoveryCache is passed to search_with_cache. search never reads or writes a cache.

Implementations

impl SearchRequest

pub fn new( root: impl Into<PathBuf>, patterns: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Create a search request with include patterns and default options.

pub fn exclude( self, patterns: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Add exclude patterns.

pub fn options(self, options: ListOptions) -> Self

Set list options.

pub fn cache_policy(self, policy: CachePolicy) -> Self

Set cache policy (only effective with an explicit cache in search_with_cache).

Trait Implementations

impl Clone for SearchRequest

fn clone(&self) -> SearchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchRequest

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

Formats the value using the given formatter.

impl Default for SearchRequest

fn default() -> Self

Returns the “default value” for a type.