Struct PatternID

impl PatternID

const MAX: PatternID = _;

The maximum value.

const LIMIT: usize = SmallIndex::LIMIT;

The total number of values that can be represented.

const ZERO: PatternID = _;

The zero value.

const SIZE: usize = SmallIndex::SIZE;

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

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.

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.

fn must(value: usize) -> PatternID

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

const fn as_usize(&self) -> usize

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

const fn as_u64(&self) -> u64

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

const fn as_u32(&self) -> u32

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

const fn as_i32(&self) -> i32

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

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.

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.

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.

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

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