Struct regex_syntax::hir::ClassBytes

pub struct ClassBytes { /* private fields */ }

A set of characters represented by arbitrary bytes.

Each byte corresponds to one character.

Implementations

impl ClassBytes

pub fn new<I>(ranges: I) -> ClassBytes

where I: IntoIterator<Item = ClassBytesRange>,

Create a new class from a sequence of ranges.

The given ranges do not need to be in any specific order, and ranges may overlap. Ranges will automatically be sorted into a canonical non-overlapping order.

pub fn empty() -> ClassBytes

Create a new class with no ranges.

An empty class matches nothing. That is, it is equivalent to Hir::fail.

pub fn push(&mut self, range: ClassBytesRange)

Add a new range to this set.

pub fn iter(&self) -> ClassBytesIter<'_>

Return an iterator over all ranges in this class.

The iterator yields ranges in ascending order.

pub fn ranges(&self) -> &[ClassBytesRange]

Return the underlying ranges as a slice.

pub fn case_fold_simple(&mut self)

Expand this character class such that it contains all case folded characters. For example, if this class consists of the range a-z, then applying case folding will result in the class containing both the ranges a-z and A-Z.

Note that this only applies ASCII case folding, which is limited to the characters a-z and A-Z.

pub fn negate(&mut self)

Negate this byte class.

For all b where b is a any byte, if b was in this set, then it will not be in this set after negation.

pub fn union(&mut self, other: &ClassBytes)

Union this byte class with the given byte class, in place.

pub fn intersect(&mut self, other: &ClassBytes)

Intersect this byte class with the given byte class, in place.

pub fn difference(&mut self, other: &ClassBytes)

Subtract the given byte class from this byte class, in place.

pub fn symmetric_difference(&mut self, other: &ClassBytes)

Compute the symmetric difference of the given byte classes, in place.

This computes the symmetric difference of two byte classes. This removes all elements in this class that are also in the given class, but all adds all elements from the given class that aren’t in this class. That is, the class will contain all elements in either class, but will not contain any elements that are in both classes.

pub fn is_ascii(&self) -> bool

Returns true if and only if this character class will either match nothing or only ASCII bytes. Stated differently, this returns false if and only if this class contains a non-ASCII byte.

pub fn minimum_len(&self) -> Option<usize>

Returns the length, in bytes, of the smallest string matched by this character class.

Returns None when the class is empty.

pub fn maximum_len(&self) -> Option<usize>

Returns the length, in bytes, of the longest string matched by this character class.

Returns None when the class is empty.

pub fn literal(&self) -> Option<Vec<u8>>

If this class consists of exactly one byte, then return it as a literal byte string.

If this class is empty or contains more than one byte, then None is returned.

pub fn to_unicode_class(&self) -> Option<ClassUnicode>

If this class consists of only ASCII ranges, then return its corresponding and equivalent Unicode class.

Trait Implementations

impl Clone for ClassBytes

fn clone(&self) -> ClassBytes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClassBytes

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

Formats the value using the given formatter.

impl PartialEq for ClassBytes

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

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

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 Eq for ClassBytes

impl StructuralPartialEq for ClassBytes