Struct RegExpFlags 

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

Regular expression flags.

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions#advanced_searching_with_flags

Implementations

impl RegExpFlags

pub const G: RegExpFlags

Global flag

Causes the pattern to match multiple times.

pub const I: RegExpFlags

Ignore case flag

Causes the pattern to ignore case.

pub const M: RegExpFlags

Multiline flag

Causes ^ and $ to match the start/end of each line.

pub const S: RegExpFlags

DotAll flag

Causes . to also match newlines.

pub const U: RegExpFlags

Unicode flag

Causes the pattern to treat the input as a sequence of Unicode code points.

pub const Y: RegExpFlags

Sticky flag

Perform a “sticky” search that matches starting at the current position in the target string.

pub const D: RegExpFlags

Indices flag

Causes the regular expression to generate indices for substring matches.

pub const V: RegExpFlags

Unicode sets flag

Similar to the u flag, but also enables the \\p{} and \\P{} syntax. Added by the v flag proposal.

impl RegExpFlags

pub const fn empty() -> RegExpFlags

Get a flags value with all bits unset.

pub const fn all() -> RegExpFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u8) -> Option<RegExpFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> RegExpFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> RegExpFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<RegExpFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: RegExpFlags) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: RegExpFlags) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: RegExpFlags)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: RegExpFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: RegExpFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: RegExpFlags, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: RegExpFlags) -> RegExpFlags

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: RegExpFlags) -> RegExpFlags

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: RegExpFlags) -> RegExpFlags

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: RegExpFlags) -> RegExpFlags

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> RegExpFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl RegExpFlags

pub const fn iter(&self) -> Iter<RegExpFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<RegExpFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl RegExpFlags

pub fn to_inline_string(self) -> InlineString<8, usize>

Convert RegExpFlags to an InlineString.

This performs the same role as RegExpFlags::to_string, but does not allocate.

Trait Implementations

impl Binary for RegExpFlags

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

Formats the value using the given formatter.

impl BitAnd for RegExpFlags

fn bitand(self, other: RegExpFlags) -> RegExpFlags

The bitwise and (&) of the bits in two flags values.

type Output = RegExpFlags

The resulting type after applying the & operator.

impl BitAndAssign for RegExpFlags

fn bitand_assign(&mut self, other: RegExpFlags)

The bitwise and (&) of the bits in two flags values.

impl BitOr for RegExpFlags

fn bitor(self, other: RegExpFlags) -> RegExpFlags

The bitwise or (|) of the bits in two flags values.

type Output = RegExpFlags

The resulting type after applying the | operator.

impl BitOrAssign for RegExpFlags

fn bitor_assign(&mut self, other: RegExpFlags)

The bitwise or (|) of the bits in two flags values.

impl BitXor for RegExpFlags

fn bitxor(self, other: RegExpFlags) -> RegExpFlags

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = RegExpFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for RegExpFlags

fn bitxor_assign(&mut self, other: RegExpFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for RegExpFlags

fn clone(&self) -> RegExpFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'alloc> CloneIn<'alloc> for RegExpFlags

type Cloned = RegExpFlags

The type of the cloned object.

fn clone_in( &self, _: &'alloc Allocator, ) -> <RegExpFlags as CloneIn<'alloc>>::Cloned

Clone self into the given allocator. allocator may be the same one that self is already in.

fn clone_in_with_semantic_ids( &self, allocator: &'new_alloc Allocator, ) -> Self::Cloned

Almost identical as clone_in, but for some special type, it will also clone the semantic ids. Please use this method only if you make sure semantic info is synced with the ast node.

impl ContentEq for RegExpFlags

fn content_eq(&self, other: &RegExpFlags) -> bool

This method tests for contents of self and other to be equal.

fn content_ne(&self, other: &Self) -> bool

This method tests for contents of self and other not to be equal. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Debug for RegExpFlags

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

Formats the value using the given formatter.

impl Display for RegExpFlags

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

Formats the value using the given formatter.

impl<'a> Dummy<'a> for RegExpFlags

fn dummy(_: &'a Allocator) -> RegExpFlags

Create a dummy RegExpFlags.

Does not allocate any data into arena.

impl Extend<RegExpFlags> for RegExpFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = RegExpFlags>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for RegExpFlags

const FLAGS: &'static [Flag<RegExpFlags>]

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> RegExpFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<RegExpFlags> for RegExpFlags

fn from_iter<T>(iterator: T) -> RegExpFlags

where T: IntoIterator<Item = RegExpFlags>,

The bitwise or (|) of the bits in each flags value.

impl Hash for RegExpFlags

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for RegExpFlags

type Item = RegExpFlags

The type of the elements being iterated over.

type IntoIter = Iter<RegExpFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <RegExpFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for RegExpFlags

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

Formats the value using the given formatter.

impl Not for RegExpFlags

fn not(self) -> RegExpFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = RegExpFlags

The resulting type after applying the ! operator.

impl Octal for RegExpFlags

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

Formats the value using the given formatter.

impl Ord for RegExpFlags

fn cmp(&self, other: &RegExpFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RegExpFlags

fn eq(&self, other: &RegExpFlags) -> 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 PartialOrd for RegExpFlags

fn partial_cmp(&self, other: &RegExpFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for RegExpFlags

fn sub(self, other: RegExpFlags) -> RegExpFlags

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = RegExpFlags

The resulting type after applying the - operator.

impl SubAssign for RegExpFlags

fn sub_assign(&mut self, other: RegExpFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl TryFrom<char> for RegExpFlags

type Error = char

The type returned in the event of a conversion error.

fn try_from( value: char, ) -> Result<RegExpFlags, <RegExpFlags as TryFrom<char>>::Error>

Performs the conversion.

impl TryFrom<u8> for RegExpFlags

type Error = u8

The type returned in the event of a conversion error.

fn try_from( value: u8, ) -> Result<RegExpFlags, <RegExpFlags as TryFrom<u8>>::Error>

Performs the conversion.

impl UpperHex for RegExpFlags

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

Formats the value using the given formatter.

impl Copy for RegExpFlags

impl Eq for RegExpFlags

impl StructuralPartialEq for RegExpFlags