Struct regex_automata::PatternID

source ·
pub struct PatternID(/* private fields */);
Expand description

The identifier of a regex pattern, represented by a SmallIndex.

The identifier for a pattern corresponds to its relative position among other patterns in a single finite state machine. Namely, when building a multi-pattern regex engine, one must supply a sequence of patterns to match. The position (starting at 0) of each pattern in that sequence represents its identifier. This identifier is in turn used to identify and report matches of that pattern in various APIs.

See the SmallIndex type for more information about what it means for a pattern ID to be a “small index.”

Note that this type is defined in the util::primitives module, but it is also re-exported at the crate root due to how common it is.

Implementations§

source§

impl PatternID

source

pub const MAX: PatternID = _

The maximum value.

source

pub const LIMIT: usize = 2_147_483_647usize

The total number of values that can be represented.

source

pub const ZERO: PatternID = _

The zero value.

source

pub const SIZE: usize = 4usize

The number of bytes that a single value uses in memory.

source

pub fn new(value: usize) -> Result<PatternID, PatternIDError>

Create a new value that is represented by a “small index.”

If the given index exceeds the maximum allowed value, then this returns an error.

source

pub const fn new_unchecked(value: usize) -> PatternID

Create a new value without checking whether the given argument exceeds the maximum.

Using this routine with an invalid value will result in unspecified behavior, but not undefined behavior. In particular, an invalid ID value is likely to cause panics or possibly even silent logical errors.

Callers must never rely on this type to be within a certain range for memory safety.

source

pub fn must(value: usize) -> PatternID

Like new, but panics if the given value is not valid.

source

pub const fn as_usize(&self) -> usize

Return the internal value as a usize. This is guaranteed to never overflow usize.

source

pub const fn as_u64(&self) -> u64

Return the internal value as a u64. This is guaranteed to never overflow.

source

pub const fn as_u32(&self) -> u32

Return the internal value as a u32. This is guaranteed to never overflow u32.

source

pub const fn as_i32(&self) -> i32

Return the internal value as a i32. This is guaranteed to never overflow an i32`.

source

pub fn one_more(&self) -> usize

Returns one more than this value as a usize.

Since values represented by a “small index” have constraints on their maximum value, adding 1 to it will always fit in a usize, u32 and a i32.

source

pub fn from_ne_bytes(bytes: [u8; 4]) -> Result<PatternID, PatternIDError>

Decode this value from the bytes given using the native endian byte order for the current target.

If the decoded integer is not representable as a small index for the current target, then this returns an error.

source

pub fn from_ne_bytes_unchecked(bytes: [u8; 4]) -> PatternID

Decode this value from the bytes given using the native endian byte order for the current target.

This is analogous to new_unchecked in that is does not check whether the decoded integer is representable as a small index.

source

pub fn to_ne_bytes(&self) -> [u8; 4]

Return the underlying integer as raw bytes in native endian format.

Trait Implementations§

source§

impl Clone for PatternID

source§

fn clone(&self) -> PatternID

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 PatternID

source§

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

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

impl Default for PatternID

source§

fn default() -> PatternID

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

impl From<u8> for PatternID

source§

fn from(value: u8) -> PatternID

Converts to this type from the input type.
source§

impl Hash for PatternID

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<T> Index<PatternID> for [T]

§

type Output = T

The returned type after indexing.
source§

fn index(&self, index: PatternID) -> &T

Performs the indexing (container[index]) operation. Read more
source§

impl<T> Index<PatternID> for Vec<T>

§

type Output = T

The returned type after indexing.
source§

fn index(&self, index: PatternID) -> &T

Performs the indexing (container[index]) operation. Read more
source§

impl<T> IndexMut<PatternID> for [T]

source§

fn index_mut(&mut self, index: PatternID) -> &mut T

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<T> IndexMut<PatternID> for Vec<T>

source§

fn index_mut(&mut self, index: PatternID) -> &mut T

Performs the mutable indexing (container[index]) operation. Read more
source§

impl Ord for PatternID

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for PatternID

source§

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

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

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.
source§

impl PartialOrd for PatternID

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl TryFrom<u16> for PatternID

§

type Error = PatternIDError

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

fn try_from(value: u16) -> Result<PatternID, PatternIDError>

Performs the conversion.
source§

impl TryFrom<u32> for PatternID

§

type Error = PatternIDError

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

fn try_from(value: u32) -> Result<PatternID, PatternIDError>

Performs the conversion.
source§

impl TryFrom<u64> for PatternID

§

type Error = PatternIDError

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

fn try_from(value: u64) -> Result<PatternID, PatternIDError>

Performs the conversion.
source§

impl TryFrom<usize> for PatternID

§

type Error = PatternIDError

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

fn try_from(value: usize) -> Result<PatternID, PatternIDError>

Performs the conversion.
source§

impl Copy for PatternID

source§

impl Eq for PatternID

source§

impl StructuralPartialEq for PatternID

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> 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,

§

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>,

§

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>,

§

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.