Struct Builder 

pub struct Builder<'a, 'f1, S: State = Empty> { /* private fields */ }

Available on crate features regex-automata and regex-lita only.

Use builder syntax to set the inputs and finish with build_from_hir().

Implementations

impl<'a, 'f1, S: State> Builder<'a, 'f1, S>

pub fn build_from_hir(self, hir: Hir) -> Result<Regex<'a>, BuildError>

where S: IsComplete,

Builds a Regex directly from an Hir expression.

This is useful if you needed to parse a pattern string into an Hir for other reasons (such as analysis or transformations). This routine permits building a Regex directly from the Hir expression instead of first converting the Hir back to a pattern string.

When using this method, any options set via Builder::syntax are ignored. Namely, the syntax options only apply when parsing a pattern string, which isn’t relevant here.

If there was a problem building the underlying regex matcher for the given Hir, then an error is returned.

Example

This example shows how one can hand-construct an Hir expression and build a regex from it without doing any parsing at all.

use ib_matcher::{
    regex::{lita::Regex, Match},
    syntax::regex::hir::{Hir, Look},
};

// (?Rm)^foo$
let hir = Hir::concat(vec![
    Hir::look(Look::StartCRLF),
    Hir::literal("foo".as_bytes()),
    Hir::look(Look::EndCRLF),
]);
let re = Regex::builder()
    .build_from_hir(hir)?;
let hay = "\r\nfoo\r\n";
assert_eq!(Some(Match::must(0, 2..5)), re.find(hay));

Ok::<(), Box<dyn std::error::Error>>(())

pub fn hir_ascii(self, value: (Hir, bool)) -> Builder<'a, 'f1, SetHirAscii<S>>

where S::HirAscii: IsUnset,

Optional (Some / Option setters).

If the provided hir is Unicode-aware, providing a ASCII-aware-only Hir as hir_ascii can improve performance.

The second bool is whether the provided hir_ascii is case insensitive:

• If it’s false but ib.case_insensitive is true, then hir_ascii will be converted to case insensitive. (Used by glob)
• If it’s true but ib.case_insensitive is false, build() will panic.

pub fn maybe_hir_ascii( self, value: Option<(Hir, bool)>, ) -> Builder<'a, 'f1, SetHirAscii<S>>

where S::HirAscii: IsUnset,

Optional (Some / Option setters).

If the provided hir is Unicode-aware, providing a ASCII-aware-only Hir as hir_ascii can improve performance.

The second bool is whether the provided hir_ascii is case insensitive:

• If it’s false but ib.case_insensitive is true, then hir_ascii will be converted to case insensitive. (Used by glob)
• If it’s true but ib.case_insensitive is false, build() will panic.

pub fn dfa_dense(self, value: Config) -> Builder<'a, 'f1, SetDfaDense<S>>

where S::DfaDense: IsUnset,

Optional (Some / Option setters). Default: <dfa::dense::Config as Default>::default().

pub fn maybe_dfa_dense( self, value: Option<Config>, ) -> Builder<'a, 'f1, SetDfaDense<S>>

where S::DfaDense: IsUnset,

Optional (Some / Option setters). Default: <dfa::dense::Config as Default>::default().

pub fn thompson(self, value: Config) -> Builder<'a, 'f1, SetThompson<S>>

where S::Thompson: IsUnset,

Optional (Some / Option setters). Default: <thompson::Config as Default>::default().

Thompson NFA config. Named configure to be compatible with regex_automata::meta::Builder. Although some fields are not supported and utf8_empty is named as utf8 instead.

pub fn maybe_thompson( self, value: Option<Config>, ) -> Builder<'a, 'f1, SetThompson<S>>

where S::Thompson: IsUnset,

Optional (Some / Option setters). Default: <thompson::Config as Default>::default().

Thompson NFA config. Named configure to be compatible with regex_automata::meta::Builder. Although some fields are not supported and utf8_empty is named as utf8 instead.

pub fn ib(self, value: MatchConfig<'a>) -> Builder<'a, 'f1, SetIb<S>>

where S::Ib: IsUnset,

Optional (Some / Option setters). Default: MatchConfig::builder().case_insensitive(false).build().

[IbMatcher] config.

pub fn maybe_ib( self, value: Option<MatchConfig<'a>>, ) -> Builder<'a, 'f1, SetIb<S>>

where S::Ib: IsUnset,

Optional (Some / Option setters). Default: MatchConfig::builder().case_insensitive(false).build().

[IbMatcher] config.

pub fn ib_parser( self, value: &'f1 mut dyn FnMut(&str) -> Pattern<'_, str>, ) -> Builder<'a, 'f1, SetIbParser<S>>

where S::IbParser: IsUnset,

Optional (Some / Option setters).

IbMatcher pattern parser.

Example

use ib_matcher::{regex::lita::Regex, matcher::{MatchConfig, pattern::Pattern}};

let re = Regex::builder()
    .ib(MatchConfig::builder().pinyin(Default::default()).build())
    .ib_parser(&mut |pattern| Pattern::parse_ev(pattern).call())
    .build("pinyin;py")
    .unwrap();
assert!(re.is_match("拼音搜索"));
assert!(re.is_match("pinyin") == false);

See crate::syntax::ev for more details.

pub fn maybe_ib_parser( self, value: Option<&'f1 mut dyn FnMut(&str) -> Pattern<'_, str>>, ) -> Builder<'a, 'f1, SetIbParser<S>>

where S::IbParser: IsUnset,

Optional (Some / Option setters).

IbMatcher pattern parser.

Example

use ib_matcher::{regex::lita::Regex, matcher::{MatchConfig, pattern::Pattern}};

let re = Regex::builder()
    .ib(MatchConfig::builder().pinyin(Default::default()).build())
    .ib_parser(&mut |pattern| Pattern::parse_ev(pattern).call())
    .build("pinyin;py")
    .unwrap();
assert!(re.is_match("拼音搜索"));
assert!(re.is_match("pinyin") == false);

See crate::syntax::ev for more details.

pub fn backtrack(self, value: Config) -> Builder<'a, 'f1, SetBacktrack<S>>

where S::Backtrack: IsUnset,

Optional (Some / Option setters). Default: backtrack::Config::new().visited_capacity(usize::MAX / 8).

pub fn maybe_backtrack( self, value: Option<Config>, ) -> Builder<'a, 'f1, SetBacktrack<S>>

where S::Backtrack: IsUnset,

Optional (Some / Option setters). Default: backtrack::Config::new().visited_capacity(usize::MAX / 8).

impl<'a, S: State> Builder<'a, '_, S>

pub fn syntax(self, syntax: Config) -> Self

Configure the syntax options when parsing a pattern string while building a Regex.

These options only apply when Builder::build or [Builder::build_many] are used. The other build methods accept Hir values, which have already been parsed.

Example

This example shows how to enable case insensitive mode.

use ib_matcher::regex::{lita::Regex, util::syntax, Match};

let re = Regex::builder()
    .syntax(syntax::Config::new().case_insensitive(true))
    .build(r"δ")?;
assert_eq!(Some(Match::must(0, 0..2)), re.find(r"Δ"));

Ok::<(), Box<dyn std::error::Error>>(())

pub fn build(self, pattern: &str) -> Result<Regex<'a>, BuildError>

where S::HirAscii: IsUnset,

Builds a Regex from a single pattern string.

If there was a problem parsing the pattern or a problem turning it into a regex matcher, then an error is returned.

Example

This example shows how to configure syntax options.

use ib_matcher::regex::{lita::Regex, util::syntax, Match};

let re = Regex::builder()
    .syntax(syntax::Config::new().crlf(true).multi_line(true))
    .build(r"^foo$")?;
let hay = "\r\nfoo\r\n";
assert_eq!(Some(Match::must(0, 2..5)), re.find(hay));