regex_syntax::hir::translate

Struct TranslatorBuilder

Source
pub struct TranslatorBuilder { /* private fields */ }
Expand description

A builder for constructing an AST->HIR translator.

Implementations§

Source§

impl TranslatorBuilder

Source

pub fn new() -> TranslatorBuilder

Create a new translator builder with a default c onfiguration.

Source

pub fn build(&self) -> Translator

Build a translator using the current configuration.

Source

pub fn utf8(&mut self, yes: bool) -> &mut TranslatorBuilder

When disabled, translation will permit the construction of a regular expression that may match invalid UTF-8.

When enabled (the default), the translator is guaranteed to produce an expression that, for non-empty matches, will only ever produce spans that are entirely valid UTF-8 (otherwise, the translator will return an error).

Perhaps surprisingly, when UTF-8 is enabled, an empty regex or even a negated ASCII word boundary (uttered as (?-u:\B) in the concrete syntax) will be allowed even though they can produce matches that split a UTF-8 encoded codepoint. This only applies to zero-width or “empty” matches, and it is expected that the regex engine itself must handle these cases if necessary (perhaps by suppressing any zero-width matches that split a codepoint).

Source

pub fn line_terminator(&mut self, byte: u8) -> &mut TranslatorBuilder

Sets the line terminator for use with (?u-s:.) and (?-us:.).

Namely, instead of . (by default) matching everything except for \n, this will cause . to match everything except for the byte given.

If . is used in a context where Unicode mode is enabled and this byte isn’t ASCII, then an error will be returned. When Unicode mode is disabled, then any byte is permitted, but will return an error if UTF-8 mode is enabled and it is a non-ASCII byte.

In short, any ASCII value for a line terminator is always okay. But a non-ASCII byte might result in an error depending on whether Unicode mode or UTF-8 mode are enabled.

Note that if R mode is enabled then it always takes precedence and the line terminator will be treated as \r and \n simultaneously.

Note also that this doesn’t impact the look-around assertions (?m:^) and (?m:$). That’s usually controlled by additional configuration in the regex engine itself.

Source

pub fn case_insensitive(&mut self, yes: bool) -> &mut TranslatorBuilder

Enable or disable the case insensitive flag (i) by default.

Source

pub fn multi_line(&mut self, yes: bool) -> &mut TranslatorBuilder

Enable or disable the multi-line matching flag (m) by default.

Source

pub fn dot_matches_new_line(&mut self, yes: bool) -> &mut TranslatorBuilder

Enable or disable the “dot matches any character” flag (s) by default.

Source

pub fn crlf(&mut self, yes: bool) -> &mut TranslatorBuilder

Enable or disable the CRLF mode flag (R) by default.

Source

pub fn swap_greed(&mut self, yes: bool) -> &mut TranslatorBuilder

Enable or disable the “swap greed” flag (U) by default.

Source

pub fn unicode(&mut self, yes: bool) -> &mut TranslatorBuilder

Enable or disable the Unicode flag (u) by default.

Trait Implementations§

Source§

impl Clone for TranslatorBuilder

Source§

fn clone(&self) -> TranslatorBuilder

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TranslatorBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TranslatorBuilder

Source§

fn default() -> TranslatorBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.