Struct regex_automata::SyntaxConfig

pub struct SyntaxConfig { /* private fields */ }

A common set of configuration options that apply to the syntax of a regex.

This represents a group of configuration options that specifically apply to how the concrete syntax of a regular expression is interpreted. In particular, they are generally forwarded to the ParserBuilder in the regex-syntax crate when building a regex from its concrete syntax directly.

These options are defined as a group since they apply to every regex engine in this crate. Instead of re-defining them on every engine’s builder, they are instead provided here as one cohesive unit.

Implementations

impl SyntaxConfig

pub fn new() -> SyntaxConfig

Return a new default syntax configuration.

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

Enable or disable the case insensitive flag by default.

When Unicode mode is enabled, case insensitivity is Unicode-aware. Specifically, it will apply the “simple” case folding rules as specified by Unicode.

By default this is disabled. It may alternatively be selectively enabled in the regular expression itself via the i flag.

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

Enable or disable the multi-line matching flag by default.

When this is enabled, the ^ and $ look-around assertions will match immediately after and immediately before a new line character, respectively. Note that the \A and \z look-around assertions are unaffected by this setting and always correspond to matching at the beginning and end of the input.

By default this is disabled. It may alternatively be selectively enabled in the regular expression itself via the m flag.

pub fn dot_matches_new_line(self, yes: bool) -> SyntaxConfig

Enable or disable the “dot matches any character” flag by default.

When this is enabled, . will match any character. When it’s disabled, then . will match any character except for a new line character.

Note that . is impacted by whether the “unicode” setting is enabled or not. When Unicode is enabled (the defualt), . will match any UTF-8 encoding of any Unicode scalar value (sans a new line, depending on whether this “dot matches new line” option is enabled). When Unicode mode is disabled, . will match any byte instead. Because of this, when Unicode mode is disabled, . can only be used when the “allow invalid UTF-8” option is enabled, since . could otherwise match invalid UTF-8.

By default this is disabled. It may alternatively be selectively enabled in the regular expression itself via the s flag.

pub fn swap_greed(self, yes: bool) -> SyntaxConfig

Enable or disable the “swap greed” flag by default.

When this is enabled, .* (for example) will become ungreedy and .*? will become greedy.

By default this is disabled. It may alternatively be selectively enabled in the regular expression itself via the U flag.

pub fn ignore_whitespace(self, yes: bool) -> SyntaxConfig

Enable verbose mode in the regular expression.

When enabled, verbose mode permits insigificant whitespace in many places in the regular expression, as well as comments. Comments are started using # and continue until the end of the line.

By default, this is disabled. It may be selectively enabled in the regular expression by using the x flag regardless of this setting.

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

Enable or disable the Unicode flag (u) by default.

By default this is enabled. It may alternatively be selectively disabled in the regular expression itself via the u flag.

Note that unless “allow invalid UTF-8” is enabled (it’s disabled by default), a regular expression will fail to parse if Unicode mode is disabled and a sub-expression could possibly match invalid UTF-8.

WARNING: Unicode mode can greatly increase the size of the compiled DFA, which can noticeably impact both memory usage and compilation time. This is especially noticeable if your regex contains character classes like \w that are impacted by whether Unicode is enabled or not. If Unicode is not necessary, you are encouraged to disable it.

pub fn utf8(self, yes: bool) -> SyntaxConfig

When disabled, the builder will permit the construction of a regular expression that may match invalid UTF-8.

For example, when SyntaxConfig::unicode is disabled, then expressions like [^a] may match invalid UTF-8 since they can match any single byte that is not a. By default, these sub-expressions are disallowed to avoid returning offsets that split a UTF-8 encoded codepoint. However, in cases where matching at arbitrary locations is desired, this option can be disabled to permit all such sub-expressions.

When enabled (the default), the builder is guaranteed to produce a regex that will only ever match valid UTF-8 (otherwise, the builder will return an error).

pub fn nest_limit(self, limit: u32) -> SyntaxConfig

Set the nesting limit used for the regular expression parser.

The nesting limit controls how deep the abstract syntax tree is allowed to be. If the AST exceeds the given limit (e.g., with too many nested groups), then an error is returned by the parser.

The purpose of this limit is to act as a heuristic to prevent stack overflow when building a finite automaton from a regular expression’s abstract syntax tree. In particular, construction currently uses recursion. In the future, the implementation may stop using recursion and this option will no longer be necessary.

This limit is not checked until the entire AST is parsed. Therefore, if callers want to put a limit on the amount of heap space used, then they should impose a limit on the length, in bytes, of the concrete pattern string. In particular, this is viable since the parser will limit itself to heap space proportional to the lenth of the pattern string.

Note that a nest limit of 0 will return a nest limit error for most patterns but not all. For example, a nest limit of 0 permits a but not ab, since ab requires a concatenation AST item, which results in a nest depth of 1. In general, a nest limit is not something that manifests in an obvious way in the concrete syntax, therefore, it should not be used in a granular way.

pub fn octal(self, yes: bool) -> SyntaxConfig

Whether to support octal syntax or not.

Octal syntax is a little-known way of uttering Unicode codepoints in a regular expression. For example, a, \x61, \u0061 and \141 are all equivalent regular expressions, where the last example shows octal syntax.

While supporting octal syntax isn’t in and of itself a problem, it does make good error messages harder. That is, in PCRE based regex engines, syntax like \1 invokes a backreference, which is explicitly unsupported in Rust’s regex engine. However, many users expect it to be supported. Therefore, when octal support is disabled, the error message will explicitly mention that backreferences aren’t supported.

Octal syntax is disabled by default.

pub fn get_unicode(&self) -> bool

Returns whether “unicode” mode is enabled.

pub fn get_case_insensitive(&self) -> bool

Returns whether “case insensitive” mode is enabled.

pub fn get_multi_line(&self) -> bool

Returns whether “multi line” mode is enabled.

pub fn get_dot_matches_new_line(&self) -> bool

Returns whether “dot matches new line” mode is enabled.

pub fn get_swap_greed(&self) -> bool

Returns whether “swap greed” mode is enabled.

pub fn get_ignore_whitespace(&self) -> bool

Returns whether “ignore whitespace” mode is enabled.

pub fn get_utf8(&self) -> bool

Returns whether UTF-8 mode is enabled.

pub fn get_nest_limit(&self) -> u32

Returns the “nest limit” setting.

pub fn get_octal(&self) -> bool

Returns whether “octal” mode is enabled.

Trait Implementations

impl Clone for SyntaxConfig

fn clone(&self) -> SyntaxConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxConfig

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

Formats the value using the given formatter.

impl Default for SyntaxConfig

fn default() -> SyntaxConfig

Returns the “default value” for a type.

impl Copy for SyntaxConfig