Struct regex::literal::LiteralSearcher

pub struct LiteralSearcher {
    complete: bool,
    lcp: FreqyPacked,
    lcs: FreqyPacked,
    matcher: Matcher,
}

A prefix extracted from a compiled regular expression.

A regex prefix is a set of literal strings that must be matched at the beginning of a regex in order for the entire regex to match. Similarly for a regex suffix.

Fields

complete: bool

lcp: FreqyPacked

lcs: FreqyPacked

matcher: Matcher

Methods

impl LiteralSearcher

pub fn empty() -> Self

Returns a matcher that never matches and never advances the input.

pub fn prefixes(lits: Literals) -> Self

Returns a matcher for literal prefixes from the given set.

pub fn suffixes(lits: Literals) -> Self

Returns a matcher for literal suffixes from the given set.

fn new(lits: Literals, matcher: Matcher) -> Self

pub fn complete(&self) -> bool

Returns true if all matches comprise the entire regular expression.

This does not necessarily mean that a literal match implies a match of the regular expression. For example, the regular expresison ^a is comprised of a single complete literal a, but the regular expression demands that it only match at the beginning of a string.

pub fn find(&self, haystack: &[u8]) -> Option<(usize, usize)>

Find the position of a literal in haystack if it exists.

pub fn find_start(&self, haystack: &[u8]) -> Option<(usize, usize)>

Like find, except matches must start at index 0.

pub fn find_end(&self, haystack: &[u8]) -> Option<(usize, usize)>

Like find, except matches must end at index haystack.len().

Important traits for LiteralIter<'a>

impl<'a> Iterator for LiteralIter<'a> type Item = &'a [u8];

pub fn iter(&self) -> LiteralIter

Returns an iterator over all literals to be matched.

pub fn lcp(&self) -> &FreqyPacked

Returns a matcher for the longest common prefix of this matcher.

pub fn lcs(&self) -> &FreqyPacked

Returns a matcher for the longest common suffix of this matcher.

pub fn is_empty(&self) -> bool

Returns true iff this prefix is empty.

pub fn len(&self) -> usize

Returns the number of prefixes in this machine.

pub fn approximate_size(&self) -> usize

Return the approximate heap usage of literals in bytes.

Trait Implementations

impl Clone for LiteralSearcher

fn clone(&self) -> LiteralSearcher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LiteralSearcher

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

Formats the value using the given formatter.