Struct EasyRegex

pub struct EasyRegex(/* private fields */);

Main struct includes methods to be chained together in order to create a regular expression.

Implementations

impl EasyRegex

pub fn literal(self, expression: &str, settings: &Settings) -> EasyRegex

Creates a literal regular expression.

This method takes an expression (a segment of entire pattern) followed by a set of settings (Settings struct) that will be concatenated/inserted to the expression itself, outputing the previous pattern followed by this prepared regular expression.

Examples

use easy_regex::{EasyRegex, settings::base::DEFAULT};
 
let result = EasyRegex::new_section().literal("some expression", &DEFAULT);
assert_eq!("some expression", result.get_regex().unwrap().as_str());

impl EasyRegex

pub fn group(self, expression: &str, group_sttings: &GroupSettings) -> Self

Creates a group of expressions.

This method takes an expression (a segment of entire pattern) followed by a set of settings (GroupSettings struct) that will be concatenated/inserted to the expression itself, outputing the previous pattern followed by this group.

Examples

use easy_regex::{EasyRegex, settings::group::OPTIONAL_GROUP};
 
let result = EasyRegex::new_section().group("expression", &OPTIONAL_GROUP);
assert_eq!("(expression)?", result.get_regex().unwrap().as_str());

pub fn named_group( self, name: &str, expression: &str, group_settings: &GroupSettings, ) -> Self

Same as the group method with the option to add a custom name to the group.

Examples

use easy_regex::{EasyRegex, settings::group::OPTIONAL_GROUP};
 
let result = EasyRegex::new_section().named_group("my_group", "expression", &OPTIONAL_GROUP);
assert_eq!("(?P<my_group>expression)?", result.get_regex().unwrap().as_str());

pub fn into_group(self, settings: &Settings) -> Self

Turns the previous expressions into a capturing group. It uses Settings struct for the settings parameter.

Examples

use easy_regex::{EasyRegex, settings::base::OPTIONAL};
 
let result = EasyRegex::new(r"\d{3}").into_group(&OPTIONAL);
assert_eq!(r"(\d{3})?", result.get_regex().unwrap().as_str());

pub fn into_named_group(self, name: &str, settings: &Settings) -> Self

A variation of into_group having name option (?P<name>RegExp).

pub fn into_non_capturing(self) -> Self

A variation of into_group having non-capturing option (?:RegExp).

pub fn into_insensitive_group(self) -> Self

A variation of into_group having Insensitive flag (?i).

pub fn into_multline_group(self) -> Self

A variation of into_group having Multiline flag (?m).

pub fn into_dot_match_newline_group(self) -> Self

A variation of into_group having Dot All flag (?s).

pub fn into_ignore_whitespace_group(self) -> Self

A variation of into_group ignoring whitespaces (?x).

pub fn into_insensitive_non_capturing(self) -> Self

A variation of into_non_capturing having Insensitive flag (?i).

pub fn into_multiline_non_capturing(self) -> Self

A variation of into_non_capturing having Multiline flag (?m).

pub fn into_dot_match_newline_non_capturing(self) -> Self

A variation of into_non_capturing having Dot All flag (?s).

pub fn into_ignore_whitespace_non_capturing(self) -> Self

A variation of into_non_capturing ignoring whitespaces (?x).

pub fn into_sensitive_group(self) -> Self

A variation of into_group having Insensitive flag cleared (?-i).

pub fn into_single_line_group(self) -> Self

A variation of into_group having Multiline flag cleared (?-m).

pub fn into_dot_dismatch_newline_group(self) -> Self

A variation of into_group having Dot All flag cleared (?-s).

pub fn into_include_whitespace_group(self) -> Self

A variation of into_group taking whitespaces into account (?-x).

pub fn into_sensitive_non_capturing(self) -> Self

A variation of into_non_capturing having Insensitive flag cleared (?-i).

pub fn into_single_line_non_capturing(self) -> Self

A variation of into_non_capturing having Multiline flag cleared (?-m).

pub fn into_dot_dismatch_newline_non_capturing(self) -> Self

A variation of into_non_capturing having Dot All flag cleared (?-s).

pub fn into_include_whitespace_non_capturing(self) -> Self

A variation of into_non_capturing taking whitespaces into account (?-x).

impl EasyRegex

pub fn list(self, expression: &str, settings: &Settings) -> EasyRegex

Creates a list of expressions.

This method takes an expression (a segment of entire pattern) followed by a set of settings (Settings struct) that will be concatenated/inserted to the expression itself, outputing the previous pattern followed by this list.

Examples

use easy_regex::{EasyRegex, settings::base::DEFAULT};
let result = EasyRegex::new_section().list("some_list", &DEFAULT);
assert_eq!("[some_list]", result.get_regex().unwrap().as_str());

pub fn into_list(self, settings: &Settings) -> EasyRegex

Turns the previous expressions into a list.

Examples

use easy_regex::{EasyRegex, settings::base::OPTIONAL_UNGREEDY};

let result = EasyRegex::new(r"a-z").into_list(&OPTIONAL_UNGREEDY);
assert_eq!(r"[a-z]??", result.get_regex().unwrap().as_str());

impl EasyRegex

pub fn start_of_line() -> Self

Creates an EasyRegex instance starting with the ^ character, asserts position at start of the string.

pub fn or(self) -> Self

Adds the alternation symbol | to the expression.

pub fn not(self, expression: &str) -> Self

Creates a list having ^ at the beginning.

Examples

use easy_regex::EasyRegex;

let result = EasyRegex::new_section().not("abc");
assert_eq!("[^abc]", result.get_regex().unwrap().as_str());

pub fn literal_space(self) -> Self

Adds one space character i.e. “ “ to the previous expression.

pub fn end_of_line(self) -> Self

Adds the ending pattern $, asserts position at the end of the string.

pub fn insensitive() -> Self

Creates an EasyRegex instance starting with the (?i) flag.

pub fn multiline() -> Self

Creates an EasyRegex instance starting with the (?m) flag.

pub fn dot_match_newline() -> Self

Creates an EasyRegex instance starting with the (?s) flag.

pub fn ignore_whitespace() -> Self

Creates an EasyRegex instance starting with the (?x) flag.

impl EasyRegex

pub fn only_the_beginning() -> Self

Creates an EasyRegex instance starting with the \A character, asserts position at start of the string.

pub fn word_boundary(self) -> Self

Adds the \b metacharacter, asserts position at a word boundary.

pub fn word(self, settings: &Settings) -> Self

Adds the \w metacharacter, matches any word character [a-zA-Z0-9_].

pub fn non_word(self, settings: &Settings) -> Self

Adds the \w metacharacter, matches any non-word character [^a-zA-Z0-9_].

pub fn digit(self, settings: &Settings) -> Self

Adds the \d metacharacter, matches digit character [0-9].

pub fn non_digit(self, settings: &Settings) -> Self

Adds the \D metacharacter, matches any non-digit character [^0-9].

pub fn whitespace(self, settings: &Settings) -> Self

Adds the \s metacharacter, matches any whitespace character [\r\n\t\f\v ].

pub fn non_whitespace(self, settings: &Settings) -> Self

Adds the \S metacharacter, matches any non-whitespace character [^\r\n\t\f\v ].

pub fn non_word_boundary(self) -> Self

Adds the \B metacharacter, asserts position anywhere but NOT at a word boundary.

pub fn only_the_end(self) -> Self

Adds the ending metacharacter \z, asserts position at the end of the text.

impl EasyRegex

pub fn new(raw: &str) -> Self

Creates an EasyRegex instance, having initial raw pattern.

pub fn new_section() -> Self

Creates an empty EasyRegex instance, useful for start of a pattern.

pub fn get_regex(self) -> Result<Regex, Error>

Retrieves the prepared regular expression as a Result.

Trait Implementations

impl Clone for EasyRegex

fn clone(&self) -> EasyRegex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EasyRegex

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

Formats the value using the given formatter.