Struct ieql::common::pattern::Pattern

pub struct Pattern {
    pub content: String,
    pub kind: PatternKind,
}

The Pattern struct represents an uncompiled pattern. Patterns are essentially RegEx searches; given an expression, they theoretically will match text. Note that in order for patterns to actually match text, they must first be compiled. (See CompiledPattern).

Fields

content: String

The pattern to match; either plaintext or a regular expression, depending on the value of kind. Note that RegEx lookbacks are not supported; all RegEx expressions must search in linear time. See the Rust regex documentation for more information.

kind: PatternKind

Represents the type of pattern; i.e. RegEx or Raw.

Methods

impl Pattern

pub fn get_as_safe_regex(&self) -> String

Given any pattern, this function returns its expression as safe-to-compile RegEx. For Raw patterns, the expression is escaped; for RegEx patterns, it is cloned. Note that this function does not validate whether the RegEx is valid; it simply prepares it for compilation.

This is a utility function, and is currently not used during compilation.

Trait Implementations

impl Validatable for Pattern

fn validate(&self) -> Option<Vec<Issue>>

This function determines whether the Pattern is valid. It performs a compilation check for itself and for its RegEx.

Returns None if there is no issue; otherwise, Some(Vec<Issue>).

impl CompilableTo<CompiledPattern> for Pattern

fn compile(&self) -> Result<CompiledPattern, Issue>

This function compiles the Pattern into a CompiledPattern by escaping the RegEx expression as necessary and then compiling it.

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 PartialEq<Pattern> for Pattern

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

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

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

This method tests for !=.

impl Debug for Pattern

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

Formats the value using the given formatter.

impl Serialize for Pattern

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Pattern

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

Deserialize this value from the given Serde deserializer.