impl ClassUnicode

fn new<I>(ranges: I) -> ClassUnicode
where
    I: IntoIterator<Item = ClassUnicodeRange>,

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.

fn empty() -> ClassUnicode

Create a new class with no ranges.

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

fn push(&mut self, range: ClassUnicodeRange)

Add a new range to this set.

fn iter(&self) -> ClassUnicodeIter<'_>

Return an iterator over all ranges in this class.

The iterator yields ranges in ascending order.

fn ranges(&self) -> &[ClassUnicodeRange]

Return the underlying ranges as a slice.

fn case_fold_simple(&mut self)

Expand this character class such that it contains all case folded characters, according to Unicode's "simple" mapping. 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.

Panics

This routine panics when the case mapping data necessary for this routine to complete is unavailable. This occurs when the unicode-case feature is not enabled.

Callers should prefer using try_case_fold_simple instead, which will return an error instead of panicking.

fn try_case_fold_simple(&mut self) -> Result<(), CaseFoldError>

Expand this character class such that it contains all case folded characters, according to Unicode's "simple" mapping. 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.

Error

This routine returns an error when the case mapping data necessary for this routine to complete is unavailable. This occurs when the unicode-case feature is not enabled.

fn negate(&mut self)

Negate this character class.

For all c where c is a Unicode scalar value, if c was in this set, then it will not be in this set after negation.

fn union(&mut self, other: &ClassUnicode)

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

fn intersect(&mut self, other: &ClassUnicode)

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

fn difference(&mut self, other: &ClassUnicode)

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

fn symmetric_difference(&mut self, other: &ClassUnicode)

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

This computes the symmetric difference of two character 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.

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 codepoint.

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.

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.

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

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

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

fn to_byte_class(&self) -> Option<ClassBytes>

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