PatternID in regex_automata - Rust (original) (raw)
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 theutil::primitives module, but it is also re-exported at the crate root due to how common it is.
The maximum value.
The total number of values that can be represented.
The zero value.
The number of bytes that a single value uses in memory.
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.
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.
Like new, but panics if the given value is not valid.
Return the internal value as a usize. This is guaranteed to never overflow usize.
Return the internal value as a u64. This is guaranteed to never overflow.
Return the internal value as a u32. This is guaranteed to never overflow u32.
Return the internal value as a i32. This is guaranteed to never overflow an i32`.
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 ausize, u32 and a i32.
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.
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.
Return the underlying integer as raw bytes in native endian format.