Enum regex_syntax::utf8::Utf8Sequence

pub enum Utf8Sequence {
    One(Utf8Range),
    Two([Utf8Range; 2]),
    Three([Utf8Range; 3]),
    Four([Utf8Range; 4]),
}

Utf8Sequence represents a sequence of byte ranges.

To match a Utf8Sequence, a candidate byte sequence must match each successive range.

For example, if there are two ranges, [C2-DF][80-BF], then the byte sequence \xDD\x61 would not match because 0x61 < 0x80.

Variants

One(Utf8Range)

One byte range.

Two([Utf8Range; 2])

Two successive byte ranges.

Three([Utf8Range; 3])

Three successive byte ranges.

Four([Utf8Range; 4])

Four successive byte ranges.

Implementations

impl Utf8Sequence

pub fn as_slice(&self) -> &[Utf8Range]

Returns the underlying sequence of byte ranges as a slice.

pub fn len(&self) -> usize

Returns the number of byte ranges in this sequence.

The length is guaranteed to be in the closed interval [1, 4].

pub fn reverse(&mut self)

Reverses the ranges in this sequence.

For example, if this corresponds to the following sequence:

[D0-D3][80-BF]

Then after reversal, it will be

[80-BF][D0-D3]

This is useful when one is constructing a UTF-8 automaton to match character classes in reverse.

pub fn matches(&self, bytes: &[u8]) -> bool

Returns true if and only if a prefix of bytes matches this sequence of byte ranges.

Trait Implementations

impl Clone for Utf8Sequence

fn clone(&self) -> Utf8Sequence

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Utf8Sequence

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Utf8Sequence

type IntoIter = Iter<'a, Utf8Range>

Which kind of iterator are we turning this into?

type Item = &'a Utf8Range

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Utf8Sequence

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Utf8Sequence> for Utf8Sequence

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<Utf8Sequence> for Utf8Sequence

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Utf8Sequence

impl Eq for Utf8Sequence

impl StructuralEq for Utf8Sequence

impl StructuralPartialEq for Utf8Sequence