Struct hyperscan::prelude::Pattern

pub struct Pattern {
    pub expression: String,
    pub flags: Flags,
    pub id: Option<usize>,
    pub ext: ExprExt,
    pub som: Option<SomHorizon>,
}

The pattern with basic regular expression.

Fields

expression: String

The expression to parse.

flags: Flags

Flags which modify the behaviour of the expression.

id: Option<usize>

ID number to be associated with the corresponding pattern in the expressions array.

ext: ExprExt

Extended behaviour for this pattern

som: Option<SomHorizon>

The precision to track start of match offsets in stream state.

Implementations

impl Pattern

pub fn new<S: Into<String>>(expr: S) -> Result<Pattern>

Construct a pattern with expression.

pub fn with_flags<S: Into<String>>(expr: S, flags: Flags) -> Result<Pattern>

Construct a pattern with expression and flags.

pub fn caseless(self) -> Self

Set case-insensitive matching.

pub fn dot_all(self) -> Self

Matching a . will not exclude newlines.

pub fn multi_line(self) -> Self

Set multi-line anchoring.

pub fn single_match(self) -> Self

Set single-match only mode.

pub fn allow_empty(self) -> Self

Allow expressions that can match against empty buffers.

pub fn utf8(self) -> Self

Enable UTF-8 mode for this expression.

pub fn ucp(self) -> Self

Enable Unicode property support for this expression.

pub fn prefilter(self) -> Self

Enable prefiltering mode for this expression.

pub fn left_most(self) -> Self

Report the leftmost start of match offset when a match is found.

pub fn combination(self) -> Self

Logical combination.

pub fn quiet(self) -> Self

Don’t do any match reporting.

impl Pattern

pub fn info(&self) -> Result<ExprInfo>

Utility function providing information about a regular expression.

The information provided in ExpressionInfo includes the minimum and maximum width of a pattern match.

Trait Implementations

impl Builder for Pattern

fn for_platform<T: Mode>(
    &self,
    platform: Option<&PlatformRef>
) -> Result<Database<T>, Self::Err>

The basic regular expression compiler.

This is the function call with which an expression is compiled into a Hyperscan database which can be passed to the runtime functions

type Err = Error

The associated error which can be returned from compiling.

fn build<T: Mode>(&self) -> Result<Database<T>, Self::Err>

Build an expression is compiled into a Hyperscan database which can be passed to the runtime functions

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.

impl Display for Pattern

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

Formats the value using the given formatter.

impl FromIterator<Pattern> for Patterns

fn from_iter<T: IntoIterator<Item = Pattern>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Pattern

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

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: &Rhs) -> bool

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

impl Eq for Pattern

impl StructuralEq for Pattern

impl StructuralPartialEq for Pattern