Struct FuzzyRegexBuilder

Source

pub struct FuzzyRegexBuilder { /* private fields */ }

Expand description

Builder for constructing a FuzzyRegex with custom configuration.

Implementations§

Source §

impl FuzzyRegexBuilder

Source

pub fn new(pattern: &str) -> Self

Create a new builder with the given pattern.

Source

pub fn case_insensitive(self, yes: bool) -> Self

Set case-insensitive matching.

Source

pub fn verbose(self, yes: bool) -> Self

Enable verbose mode (ignore whitespace and allow # comments).

In verbose mode:

Whitespace is ignored (use \s or [ ] for literal space)
# starts a comment that extends to end of line

This allows formatting patterns for readability:

(?x)
[A-Z][a-z]+     # First name
\s+             # Whitespace
[A-Z][a-z]+     # Last name

Source

pub fn dot_all(self, yes: bool) -> Self

Enable dot-all mode (. matches newlines).

By default, . matches any character except newlines. When enabled, . matches any character including \n.

Source

pub fn multi_line(self, yes: bool) -> Self

Enable multi-line mode (^ and $ match at line boundaries).

By default, ^ matches only at the start of text and $ only at the end. When enabled:

^ also matches after each newline
$ also matches before each newline

Source

pub fn ungreedy(self, yes: bool) -> Self

Enable ungreedy mode (invert default greediness of quantifiers).

When enabled:

*, +, ? become non-greedy (match as little as possible)
*?, +?, ?? become greedy (match as much as possible)

This is equivalent to the (?U) inline flag.

Source

pub fn global(self, yes: bool) -> Self

Enable global mode (find all matches).

When enabled, use find_iter() to get all matches. When disabled (default), stops at first valid match (faster). This is equivalent to the (?g) inline flag.

Source

pub fn greedy_first(self, yes: bool) -> Self

Enable greedy first-match mode (similar to mrab-regex behavior).

When enabled, searches position by position and returns the first match found. This is faster than the default best-match behavior when matches exist early in the text, but may not find the optimal match.

Default behavior (greedy_first=false): searches all positions to find best match. Greedy first (greedy_first=true): stops at first match found.

Source

pub fn unicode(self, yes: bool) -> Self

Enable Unicode mode for character classes.

When enabled:

\w matches Unicode word characters (not just ASCII [a-zA-Z0-9_])
\d matches Unicode digits
\s matches Unicode whitespace

This is equivalent to the (?u) inline flag.

Source

pub fn similarity(self, threshold: f32) -> Self

Set the similarity threshold (0.0 - 1.0).

Matches with similarity below this threshold are rejected.

Source

pub fn edits(self, count: u8) -> Self

Set the default number of edits allowed for fuzzy matching.

This applies to literals without explicit fuzziness markers.

Source

pub fn fuzzy(self, limits: FuzzyLimits) -> Self

Set detailed fuzzy limits for default matching.

Source

pub fn penalties(self, penalties: FuzzyPenalties) -> Self

Set edit operation penalties.

Source

pub fn max_threads(self, max: usize) -> Self

Set the maximum number of threads for NFA simulation.

Higher values allow more complex patterns but use more memory.

Source

pub fn partial(self, yes: bool) -> Self

Enable partial matching.

When enabled, matches that reach the end of the text are considered successful even if they haven’t completed. The Match::partial() method can be used to check if a match is partial.

This is useful for streaming input or when the text may be truncated.

Source