Struct u24 

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

The 24-bit unsigned integer type.

Important note: Despite only representing a valid range of a 24-bit unsigned integers, this type is actually backed by u32 to ensure it’s aligned well in the registers for efficient math, copies and pretty much all operations in general.

use ttf_view::types::{BigEndian, u24, uint24};

// u24 is backed by u32
assert_eq!(size_of::<u24>(), 4);

// big-endian types still have correct size (backed by [u8; 3])
assert_eq!(size_of::<uint24>(), 3);
assert_eq!(size_of::<BigEndian<u24>>(), 3);

Implementations

impl u24

pub const BITS: u32 = 24

The size of this integer type in bits.

Examples

assert_eq!(u24::BITS, 24);

pub const MIN: Self

The smallest value that can be represented by this integer type.

Examples

assert_eq!(u24::MIN, 0);

pub const MAX: Self

The largest value that can be represented by this integer type (2²⁴ − 1).

Examples

assert_eq!(u24::MAX, 16_777_215);

pub const fn new(num: u32) -> Option<Self>

Creates a u24 from u32.

Examples

use ttf_view::types::u24;

assert_eq!(u24::new(1234).unwrap(), 1234);
assert_eq!(u24::new(15_000_000).unwrap(), 15_000_000);
assert_eq!(u24::new(0xFFFFFF).unwrap(), 0xFFFFFF);
assert_eq!(u24::new(17_000_000), None);
assert_eq!(u24::new(3_999_000_000), None);

pub const fn new_saturating(num: u32) -> Self

Creates a u24 from u32, saturating at the numeric bounds.

Examples

use ttf_view::types::u24;

assert_eq!(u24::new_saturating(1234), 1234);
assert_eq!(u24::new_saturating(15_000_000), 15_000_000);
assert_eq!(u24::new_saturating(0xFFFFFF), 0xFFFFFF);
assert_eq!(u24::new_saturating(17_000_000), 0xFFFFFF);
assert_eq!(u24::new_saturating(3_999_000_000), 0xFFFFFF);

pub const fn new_truncating(num: u32) -> Self

Creates a u24 from u32, truncating the most significant 8 bits.

Examples

use ttf_view::types::u24;

assert_eq!(u24::new_truncating(1234), 1234);
assert_eq!(u24::new_truncating(15_000_000), 15_000_000);
assert_eq!(u24::new_truncating(0xFFFFFF), 0xFFFFFF);
assert_eq!(u24::new_truncating(17_000_000), 222784);
assert_eq!(u24::new_truncating(3_999_000_000), 6022592);

pub const fn from_be_bytes(bytes: [u8; 3]) -> Self

Creates a u24 from big-endian bytes.

Examples

use ttf_view::types::u24;

assert_eq!(u24::from_be_bytes([0x00, 0x00, 0x07]), 7);
assert_eq!(u24::from_be_bytes([0x12, 0x34, 0x56]), 0x00123456);

pub const fn to_be_bytes(self) -> [u8; 3]

Gets this u24’s big-endian bytes.

Examples

use ttf_view::types::u24;

assert_eq!(u24::new(7).unwrap().to_be_bytes(), [0x00, 0x00, 0x07]);
assert_eq!(u24::new(0x00123456).unwrap().to_be_bytes(), [0x12, 0x34, 0x56]);

pub const fn get(self) -> u32

Gets the value of this u24 as u32.

Examples

use ttf_view::types::u24;

assert_eq!(u24::new(1234).unwrap(), 1234);
assert_eq!(u24::new(15_000_000).unwrap(), 15_000_000);

pub const fn wrapping_neg(self) -> Self

pub const fn wrapping_add(self, rhs: Self) -> Self

pub const fn wrapping_sub(self, rhs: Self) -> Self

pub const fn wrapping_mul(self, rhs: Self) -> Self

pub const fn wrapping_div(self, rhs: Self) -> Self

Panics

This function will panic if rhs == 0.

pub const fn wrapping_rem(self, rhs: Self) -> Self

Panics

This function will panic if rhs == 0.

pub const fn saturating_add(self, rhs: Self) -> Self

pub const fn saturating_sub(self, rhs: Self) -> Self

pub const fn saturating_mul(self, rhs: Self) -> Self

pub const fn saturating_div(self, rhs: Self) -> Self

Panics

This function will panic if rhs == 0.

pub const fn checked_neg(self) -> Option<Self>

pub const fn checked_add(self, rhs: Self) -> Option<Self>

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

pub const fn checked_mul(self, rhs: Self) -> Option<Self>

pub const fn checked_div(self, rhs: Self) -> Option<Self>

pub const fn checked_rem(self, rhs: Self) -> Option<Self>

Trait Implementations

impl Add for u24

Performs addition + (panics on overflow in debug configuration).

type Output = u24

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Binary for u24

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

Formats the value using the given formatter.

impl Clone for u24

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 u24

impl Debug for u24

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

Formats the value using the given formatter.

impl Default for u24

fn default() -> Self

Returns the “default value” for a type.

impl Display for u24

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

Formats the value using the given formatter.

impl Div for u24

Performs division /.

Panics

This operation will panic if rhs == 0.

type Output = u24

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl Eq for u24

impl From<BigEndian<u24>> for u24

fn from(value: BigEndian<u24>) -> Self

Converts to this type from the input type.

impl From<u8> for u24

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<u16> for u24

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u24> for u64

fn from(value: u24) -> Self

Converts to this type from the input type.

impl From<u24> for u32

fn from(value: u24) -> Self

Converts to this type from the input type.

impl FromStr for u24

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for u24

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

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 LowerExp for u24

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

Formats the value using the given formatter.

impl LowerHex for u24

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

Formats the value using the given formatter.

impl Mul for u24

Performs multiplication * (panics on overflow in debug configuration).

type Output = u24

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Octal for u24

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

Formats the value using the given formatter.

impl Ord for u24

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 u24

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<u32> for u24

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for u24

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 PartialOrd<u32> for u24

fn partial_cmp(&self, other: &u32) -> 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 Primitive for u24

type BigEndian = [u8; 3]

fn from_big_endian(x: Self::BigEndian) -> Self

fn to_big_endian(x: Self) -> Self::BigEndian

impl Rem for u24

Performs remainder operation %.

Panics

This operation will panic if rhs == 0.

type Output = u24

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl StructuralPartialEq for u24

impl Sub for u24

Performs subtraction - (panics on overflow in debug configuration).

type Output = u24

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl TryFrom<u24> for usize

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u24) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u24> for u16

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u24) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u24> for u8

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u24) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for u24

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for u24

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for u24

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperExp for u24

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

Formats the value using the given formatter.

impl UpperHex for u24

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

Formats the value using the given formatter.