Crate wax

Wax provides opinionated and portable globs that can be matched against file paths and directory trees. Globs use a familiar syntax and support expressive features with semantics that emphasize component boundaries.

See the repository documentation for details about glob expressions and patterns.

Structs

Any

Combinator that matches any of its component Patterns.

BuildError

Describes errors that occur when building a Pattern from a glob expression.

CandidatePath

Path that can be matched against a Pattern.

CapturingTokendiagnostics-inspect

Token that captures matched text in a glob expression.

FilterTree

Iterator adaptor that filters WalkEntrys and determines the traversal of directory trees.

Glob

Pattern that can be matched against paths and directory trees.

MatchedText

Text that has been matched by a Pattern and its captures.

Negation

Negated Globs and their associated FilterTargets.

Walk

Iterator over files matching a Glob in a directory tree.

WalkBehavior

Configuration for matching Globs against directory trees.

WalkEntry

Describes a file matching a Glob in a directory tree.

WalkError

Describes errors that occur when matching a Glob against a directory tree.

Enums

FilterTarget

Describes how files are read and discarded by FilterTree.

GlobError

General errors concerning Patterns.

LinkBehavior

Configuration for interpreting symbolic links.

Variancediagnostics-inspect

Variance of a Pattern.

Traits

DiagnosticResultExtdiagnostics-report

Extension methods for Results with diagnostics.

IteratorExt

Extension methods for Iterators concerning Globs and directory traversals.

Pattern

A representation of a glob expression that can be matched against paths.

Functions

any

Combinator that emits a Pattern that matches if any of its input Patterns match.

escape

Escapes text as a literal glob expression.

is_contextual_meta_character

Returns true if the given character is a contextual meta-character.

is_match

Returns true if a path matches a glob expression.

is_meta_character

Returns true if the given character is a meta-character.

matched

Gets text in a CandidatePath that matches a glob expression.

walk

Gets an iterator over matching files in a directory tree.

walk_with_behavior

Gets an iterator over matching files in a directory tree.

Type Definitions

DiagnosticResultdiagnostics-report

Result that includes Diagnostics on both success and failure.

Spandiagnostics-inspect

Location and length of a token within a glob expression.