Struct regex_syntax::ParserBuilder
[−]
[src]
pub struct ParserBuilder { /* fields omitted */ }
A builder for a regular expression parser.
This builder permits modifying configuration options for the parser.
This type combines the builder options for both the
AST ParserBuilder
and the
HIR TranslatorBuilder
.
Methods
impl ParserBuilder
[src]
pub fn new() -> ParserBuilder
[src]
Create a new parser builder with a default configuration.
pub fn build(&self) -> Parser
[src]
Build a parser from this configuration with the given pattern.
pub fn nest_limit(&mut self, limit: u32) -> &mut ParserBuilder
[src]
Set the nesting limit for this 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 for consumers that do structural induction on an Ast
using
explicit recursion. While this crate never does this (instead using
constant stack space and moving the call stack to the heap), other
crates may.
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 this parser implementation 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, 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(&mut self, yes: bool) -> &mut ParserBuilder
[src]
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 \0
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 allow_invalid_utf8(&mut self, yes: bool) -> &mut ParserBuilder
[src]
When enabled, the parser will permit the construction of a regular expression that may match invalid UTF-8.
When disabled (the default), the parser is guaranteed to produce an expression that will only ever match valid UTF-8 (otherwise, the parser will return an error).
Note that currently, even when invalid UTF-8 is banned, the parser
will permit a negated ASCII word boundary (i.e., (?-u:\B)
) even
though it can actually match at invalid UTF-8 boundaries. This bug
will be fixed on the next semver release.
pub fn ignore_whitespace(&mut self, yes: bool) -> &mut ParserBuilder
[src]
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 case_insensitive(&mut self, yes: bool) -> &mut ParserBuilder
[src]
Enable or disable the case insensitive flag by default.
By default this is disabled. It may alternatively be selectively
enabled in the regular expression itself via the i
flag.
pub fn multi_line(&mut self, yes: bool) -> &mut ParserBuilder
[src]
Enable or disable the multi-line matching flag by default.
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(&mut self, yes: bool) -> &mut ParserBuilder
[src]
Enable or disable the "dot matches any character" flag by default.
By default this is disabled. It may alternatively be selectively
enabled in the regular expression itself via the s
flag.
pub fn swap_greed(&mut self, yes: bool) -> &mut ParserBuilder
[src]
Enable or disable the "swap greed" flag by default.
By default this is disabled. It may alternatively be selectively
enabled in the regular expression itself via the U
flag.
pub fn unicode(&mut self, yes: bool) -> &mut ParserBuilder
[src]
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_utf8
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.
Trait Implementations
impl Clone for ParserBuilder
[src]
fn clone(&self) -> ParserBuilder
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for ParserBuilder
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Default for ParserBuilder
[src]
fn default() -> ParserBuilder
[src]
Returns the "default value" for a type. Read more