Struct PatternKeyULE 

pub struct PatternKeyULE(/* private fields */);

PatternKeyULE is a type optimized for efficient storage and deserialization of PatternKey using the ZeroVec model.

The serialization model packages the pattern item in a single byte.

The first two bits (b7 & b6) determine the variant of the pattern key:

• 00: Binary
• 01: Decimal
• 10: Power
• 11: Forbidden

The next 6 bits (b5 to b0) determine the value of the pattern key:

• For Binary, the value is mapped directly to the pattern value.
• For Decimal:
  • b5 is determining the sign of the value. if b5 is 0, the value is positive. if b5 is 1, the value is negative.
  • b4 to b0 are determining the magnitude of the value.
• For Power:
  • b5 and b4 represent the power value, which can be 10 to represent Two and 11 to represent Three.
  • b3 to b0 represent the count value, which can be:
    • 0000: Zero
    • 0001: One
    • 0010: Two
    • 0011: Few
    • 0100: Many
    • 0101: Other
  • Note: In the Power case, b3 is always 0, and when b2 is 1, b1 must be 0.

Trait Implementations

impl Clone for PatternKeyULE

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PatternKeyULE

impl Debug for PatternKeyULE

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

Formats the value using the given formatter.

impl Eq for PatternKeyULE

impl Ord for PatternKeyULE

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PatternKeyULE

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PatternKeyULE

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for PatternKeyULE

impl ULE for PatternKeyULE

fn validate_bytes(bytes: &[u8]) -> Result<(), UleError>

Validates a byte slice, &[u8].

fn parse_bytes_to_slice(bytes: &[u8]) -> Result<&[Self], UleError>

Parses a byte slice, &[u8], and return it as &[Self] with the same lifetime.

unsafe fn slice_from_bytes_unchecked(bytes: &[u8]) -> &[Self]

Takes a byte slice, &[u8], and return it as &[Self] with the same lifetime, assuming that this byte slice has previously been run through Self::parse_bytes_to_slice() with success.

fn slice_as_bytes(slice: &[Self]) -> &[u8]

Given &[Self], returns a &[u8] with the same lifetime.