Struct syntect::parsing::Regex

pub struct Regex { /* fields omitted */ }

An abstraction for regex patterns.

• Allows swapping out the regex implementation because it’s only in this module.
• Makes regexes serializable and deserializable using just the pattern string.
• Lazily compiles regexes on first use to improve initialization time.

Implementations

impl Regex

pub fn new(regex_str: String) -> Self

Create a new regex from the pattern string.

Note that the regex compilation happens on first use, which is why this method does not return a result.

pub fn try_compile(
    regex_str: &str
) -> Option<Box<dyn Error + Send + Sync + 'static>>

Check whether the pattern compiles as a valid regex or not.

pub fn regex_str(&self) -> &str

Return the regex pattern.

pub fn is_match(&self, text: &str) -> bool

Check if the regex matches the given text.

pub fn search(
    &self,
    text: &str,
    begin: usize,
    end: usize,
    region: Option<&mut Region>
) -> bool

Search for the pattern in the given text from begin/end positions.

If a region is passed, it is used for storing match group positions. The argument allows the Region to be reused between searches, which makes a significant performance difference.

Trait Implementations

impl Clone for Regex

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Regex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Regex

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Regex> for Regex

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Regex

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Regex