Enum CompactWidth

pub enum CompactWidth {
    One,
    Two,
    Four,
    Eight,
}

A minimum width of bytes needed to represent a unsigned integer.

Definition

Variants

One

The byte-width required to represent numbers up to 256 (i.e. a 8-bit number).

Two

The byte-width required to represent numbers up to 256^2 (i.e. a 16-bit number).

Four

The byte-width required to represent numbers up to 256^4 (i.e. a 32-bit number).

Eight

The byte-width required to represent numbers up to 256^8 (i.e. a 64-bit number).

Implementations

impl CompactWidth

pub fn from_u64(value: u64) -> Self

Return the most compact width in bytes (1, 2, 4, or 8) needed to represent a given u64 as a corresponding 8-bit, 16-bit, 32-bit, or 64-bit number.

Definition.

pub fn from_u32(value: u32) -> Self

Return the most compact width in bytes (1, 2, 4) needed to represent a given u32 as a corresponding 8-bit, 16-bit, or 32-bit number.

Definition.

pub fn from_u16(value: u16) -> Self

Return the most compact width in bytes (1 or 2) needed to represent a given u16 as a corresponding 8-bit or 16-bit number.

Definition.

pub fn from_u8(_: u8) -> Self

Return CompactWidth::One, the only CompactWidth needed to represent a given u8.

Definition.

pub fn width(&self) -> usize

Return the width in bytes of this CompactWidth.

pub fn bitmask(&self, position: u8) -> u8

Encode a CompactWidth as a 2-bit integer n such that 2^n gives the bytewidth of the CompactWidth, and then place that 2-bit number into a u8 at the bit-index of position.

pub fn decode_fixed_width_bitmask(mask: u8, offset: u8) -> Self

Trait Implementations

impl Debug for CompactWidth

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

Formats the value using the given formatter.

impl PartialEq for CompactWidth

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CompactWidth

impl StructuralPartialEq for CompactWidth