Struct PackedInt 

pub struct PackedInt { /* private fields */ }

An unsigned integer packed into 16 bits with variable precision.

See the crate-level documentation for the encoding, the rounding behaviour, and the ordering guarantee.

Implementations

impl PackedInt

pub const fn from_12_bits(bits: &[u8; 2]) -> PackedInt

Reads a packed value from 12 bits: all of bits[0], and the high nibble of bits[1].

The low nibble of bits[1] is reserved for the caller and is ignored.

pub const fn to_12_bits(self) -> [u8; 2]

Writes the packed value into 12 bits: all of bits[0], and the high nibble of bits[1].

The low nibble of bits[1] is left zero for the caller to use.

Twelve bits hold only the low nibble of the exponent, so this is lossless for values up to 511 × 2¹⁴ (8 372 224) and no further. Beyond that the exponent is truncated and the value reads back as an unrelated number.

pub const fn from_16_bits(bits: &[u8; 2]) -> PackedInt

Reads a packed value from two little-endian bytes.

pub const fn to_16_bits(self) -> [u8; 2]

Writes the packed value as two little-endian bytes.

pub const fn from_inner_u16(inner: u16) -> PackedInt

Reinterprets a u16 as a packed value.

Every u16 is a valid representation, so this cannot fail. It is the inverse of to_inner_u16.

pub const fn to_inner_u16(self) -> u16

Returns the underlying representation.

pub const fn from_usize(value: usize) -> PackedInt

Packs a usize, rounding up.

Returns the smallest representable value greater than or equal to value, which is value itself whenever it is below 256.

pub const fn from_u128(value: u128) -> PackedInt

Packs a u128, rounding up.

Returns the smallest representable value greater than or equal to value, which is value itself whenever it is below 256.

pub const fn from_u64(value: u64) -> PackedInt

Packs a u64, rounding up.

Returns the smallest representable value greater than or equal to value, which is value itself whenever it is below 256.

pub const fn from_u32(value: u32) -> PackedInt

Packs a u32, rounding up.

Returns the smallest representable value greater than or equal to value, which is value itself whenever it is below 256.

pub const fn from_u16(value: u16) -> PackedInt

Packs a u16, rounding up.

Returns the smallest representable value greater than or equal to value, which is value itself whenever it is below 256.

pub const fn to_usize(self) -> usize

Unpacks into a usize, saturating at usize::MAX.

Values that do not fit in the target type saturate rather than wrap.

pub const fn to_u128(self) -> u128

Unpacks into a u128, saturating at u128::MAX.

Values that do not fit in the target type saturate rather than wrap.

pub const fn to_u64(self) -> u64

Unpacks into a u64, saturating at u64::MAX.

Values that do not fit in the target type saturate rather than wrap.

pub const fn to_u32(self) -> u32

Unpacks into a u32, saturating at u32::MAX.

Values that do not fit in the target type saturate rather than wrap.

pub const fn to_u16(self) -> u16

Unpacks into a u16, saturating at u16::MAX.

Values that do not fit in the target type saturate rather than wrap.

Trait Implementations

impl Clone for PackedInt

fn clone(&self) -> PackedInt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PackedInt

impl Debug for PackedInt

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

Formats the value using the given formatter.

impl Default for PackedInt

fn default() -> PackedInt

Returns the “default value” for a type.

impl Eq for PackedInt

impl From<u32> for PackedInt

fn from(value: u32) -> PackedInt

Converts to this type from the input type.

impl From<u64> for PackedInt

fn from(value: u64) -> PackedInt

Converts to this type from the input type.

impl From<u128> for PackedInt

fn from(value: u128) -> PackedInt

Converts to this type from the input type.

impl From<usize> for PackedInt

fn from(value: usize) -> PackedInt

Converts to this type from the input type.

impl Hash for PackedInt

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PackedInt

fn cmp(&self, other: &PackedInt) -> 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 PackedInt

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PackedInt

fn partial_cmp(&self, other: &PackedInt) -> 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 PackedInt