Struct Syntax

pub struct Syntax { /* private fields */ }

Onig Syntax Wrapper

Each syntax dfines a flavour of regex syntax. This type allows interaction with the built-in syntaxes through the static accessor functions (Syntax::emacs(), Syntax::default() etc.) and the creation of custom syntaxes.

For a demonstration of creating a custom syntax see examples/syntax.rs in the main onig crate.

Implementations

impl Syntax

pub fn python() -> &'static Syntax

Python syntax

pub fn asis() -> &'static Syntax

Plain text syntax

pub fn posix_basic() -> &'static Syntax

POSIX Basic RE syntax

pub fn posix_extended() -> &'static Syntax

POSIX Extended RE syntax

pub fn emacs() -> &'static Syntax

Emacs syntax

pub fn grep() -> &'static Syntax

Grep syntax

pub fn gnu_regex() -> &'static Syntax

GNU regex syntax

pub fn java() -> &'static Syntax

Java (Sun java.util.regex) syntax

pub fn perl() -> &'static Syntax

Perl syntax

pub fn perl_ng() -> &'static Syntax

Perl + named group syntax

pub fn ruby() -> &'static Syntax

Ruby syntax

pub fn oniguruma() -> &'static Syntax

Oniguruma Syntax

pub fn default() -> &'static Syntax

Default syntax (Ruby syntax)

pub fn operators(&self) -> SyntaxOperator

Retrieve the operators for this syntax

pub fn set_operators(&mut self, operators: SyntaxOperator)

Replace the operators for this syntax

pub fn enable_operators(&mut self, operators: SyntaxOperator)

Enable Operators for this Syntax

Updates the operators for this syntax to enable the chosen ones.

pub fn disable_operators(&mut self, operators: SyntaxOperator)

Disable Operators for this Syntax

Updates the operators for this syntax to remove the specified operators.

pub fn behavior(&self) -> SyntaxBehavior

Retrieves the syntax behaviours

pub fn set_behavior(&mut self, behavior: SyntaxBehavior)

Overwrite the syntax behaviour for this syntax.

pub fn enable_behavior(&mut self, behavior: SyntaxBehavior)

Enable a given behaviour for this syntax

pub fn disable_behavior(&mut self, behavior: SyntaxBehavior)

Disable a given behaviour for this syntax

pub fn options(&self) -> RegexOptions

Retireve the syntax options for this syntax

pub fn set_options(&mut self, options: RegexOptions)

Replace the syntax options for this syntax

pub fn set_meta_char(&mut self, what: MetaCharType, meta: MetaChar)

Set a given meta character’s state

Arguments:

• what: The meta character to update
• meta: The value to set the meta character to

Trait Implementations

impl Clone for Syntax

fn clone(&self) -> Syntax

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Syntax

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

Formats the value using the given formatter.

impl Copy for Syntax