Struct Regex

pub struct Regex { /* private fields */ }

A regular expression engine designed for use within the ad text editor.

This is a relatively naive implementation though it does have some optimisations and runs reasonably quickly. It is not at all designed to be robust against mallicious input and it does not attempt to support full PCRE syntax or functionality.

Implementations

impl Regex

pub fn compile(re: &str) -> Result<Self, Error>

Attempt to compile the given regular expression into its optimised VM opcode form.

This method handles pre-allocation of the memory required for running the VM so that the allocation cost is paid once up front rather than on each use of the Regex.

pub fn compile_reverse(re: &str) -> Result<Self, Error>

Attempt to compile the given regular expression into its reversed optimised VM opcode form. This is used for searching backwards through an input stream.

This method handles pre-allocation of the memory required for running the VM so that the allocation cost is paid once up front rather than on each use of the Regex.

pub fn match_str(&mut self, input: &str) -> Option<Match>

Attempt to match this Regex against a given &str input, returning the position of the match and all submatches if successful.

pub fn match_str_all<'a, 'b>( &'a mut self, input: &'b str, ) -> MatchIter<'a, &'b str>

Iterate over all non-overlapping matches of this Regex for a given &str input.

pub fn match_buffer_all<'a, 'b>( &'a mut self, b: &'b Buffer, ) -> MatchIter<'a, &'b GapBuffer>

Iterate over all non-overlapping matches of this Regex for a given Buffer input.

pub fn match_iter<I>(&mut self, input: &mut I, sp: usize) -> Option<Match>

where I: Iterator<Item = (usize, char)>,

Attempt to match this Regex against an arbitrary iterator input, returning the position of the match and all submatches if successful.

pub fn matches_str(&mut self, input: &str) -> bool

Determine whether or not this Regex matches the input &str without searching for the leftmost-longest match and associated submatch boundaries.

pub fn matches_iter<I>(&mut self, input: &mut I, sp: usize) -> bool

where I: Iterator<Item = (usize, char)>,

Determine whether or not this Regex matches the input iterator without searching for the leftmost-longest match and associated submatch boundaries.

Trait Implementations

impl Clone for Regex

fn clone(&self) -> Regex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Regex

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

Formats the value using the given formatter.

impl PartialEq for Regex

fn eq(&self, other: &Regex) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Regex

impl StructuralPartialEq for Regex