Struct rec::Pattern

pub struct Pattern { /* fields omitted */ }

Represents a regular expression to be matched against a target.

Methods

impl Pattern

pub fn define<T: Element>(element: T) -> Self

Creates a Pattern.

This is only safe to use with Elements that are known prior to runtime.

Panics

Panics if element converts into a Rec with an invalid regular expression.

pub fn load<T: Element>(element: T) -> Result<Self, Error>

Attempts to create a Pattern.

This is intended to be used with Elements that are not known prior to runtime.

Errors

Returns regex::Error if attempt is unsuccesful.

pub fn tokenize<'t>(&self, target: &'t str) -> Tokens<'t>

Produces Tokens that match self with given target.

Important traits for TokensIter<'_, 't>

impl<'t, '_> Iterator for TokensIter<'_, 't> type Item = Tokens<'t>;

pub fn tokenize_iter<'r, 't>(&'r self, target: &'t str) -> TokensIter<'r, 't>

Produces an Iterator of Tokens that match self with given target.

After each Tokens is produced, the next one is searched from the target after the current match.

pub fn locate(&self, target: &str) -> Option<Location>

Produces Location of the match.

If no match is found, returns None.

Important traits for Locations<'_, '_>

impl<'_, '_> Iterator for Locations<'_, '_> type Item = Location;

pub fn locate_iter<'r, 't>(&'r self, target: &'t str) -> Locations<'r, 't>

Produces Locations that match self with given target.

After each Location is produced, the next one is searched from the target after the current match.

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.