Struct Region 

pub struct Region {
    pub id: String,
    pub name: String,
    pub begin: String,
    pub end: String,
    pub interp: Vec<Region>,
    pub tokenize: bool,
    pub allow_unclosed_region: bool,
    pub global: bool,
    pub references: Option<String>,
    pub singleline: bool,
    pub ignore_escaped: bool,
}

Structure that describes isolated text that should not be tokenized such as string or comment

Region can be used to create a way to describe a form of region in your code that should not be parsed. Additionally you can create interpolation rules in order to interpolate code inside.

Macro

Creating regions may be too verbose at times hence you can use defined macro to create regions

Example

reg!(str as "string literal" => {
    begin: "'",
    end: "'"
});

You can extend region with multiple options. The recommended options are:

• tokenize
• allow_unclosed_region
• singleline

Fields

id: String

identifier that will be used to reference this region in an interpolation

name: String

human-readable (preferebly all small caps) name of this region

begin: String

String that determines beginning of this region

end: String

String that determines end of this region

interp: Vec<Region>

Vector of region interpolations

tokenize: bool

This field determines if the contents of the region should be tokenized

allow_unclosed_region: bool

This field can allow to leave region unclosed after parsing has finished

global: bool

Determines if this region is the global context

references: Option<String>

Region can be a reference to some other region

singleline: bool

Determines if region cannot go past the new line character

ignore_escaped: bool

Whether to ignore escaped characters for this region only

Implementations

impl Region

pub fn new<T: AsRef<str>>( id: T, name: T, begin: T, end: T, interp: Vec<Region>, references: Option<T>, ) -> Self

Create a new region by scratch

pub fn new_global(interp: Vec<Region>) -> Region

Create a new global region

pub fn generate_region_map(&self) -> RegionMap

Generate a region for region handler

This functionality is required if we want to reference other regions. It is not supposed to be used explicitly in the code, however this can be used to debug complex region dependency tree.

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl PartialEq for Region

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Region