Struct uint24 

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

The 24-bit unsigned integer type stored in big-endian byte order.

Implementations

impl uint24

pub const BITS: u32 = 24

The size of this integer type in bits.

Examples

assert_eq!(uint24::BITS, 24);

pub const MIN: Self

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

Examples

assert_eq!(uint24::MIN, 0);

pub const MAX: Self

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

Examples

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

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

Creates a big-endian uint24 from u32.

Examples

use ttf_view::types::uint24;

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

pub const unsafe fn new_unchecked(num: u32) -> Self

Creates a big-endian uint24 from u32 without checks.

Examples

use ttf_view::types::uint24;

assert_eq!(unsafe { uint24::new_unchecked(1234).get() }, 1234);
assert_eq!(unsafe { uint24::new_unchecked(15_000_000).get() }, 15_000_000);

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

Creates a big-endian uint24 from big-endian bytes.

Examples

use ttf_view::types::uint24;

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

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

Gets this uint24’s big-endian bytes.

Examples

use ttf_view::types::uint24;

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

pub const fn get(&self) -> u32

Gets the value of this uint24 as u32.

Examples

use ttf_view::types::uint24;

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

Trait Implementations

impl Binary for uint24

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

Formats the value using the given formatter.

impl Clone for uint24

fn clone(&self) -> uint24

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for uint24

impl Debug for uint24

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

Formats the value using the given formatter.

impl Default for uint24

fn default() -> Self

Returns the “default value” for a type.

impl Display for uint24

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

Formats the value using the given formatter.

impl Eq for uint24

impl From<uint24> for u32

fn from(value: uint24) -> Self

Converts to this type from the input type.

impl FromStr for uint24

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 uint24

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 uint24

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

Formats the value using the given formatter.

impl LowerHex for uint24

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

Formats the value using the given formatter.

impl Octal for uint24

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

Formats the value using the given formatter.

impl Ord for uint24

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<u32> for uint24

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for uint24

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

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 StructuralPartialEq for uint24

impl TryFrom<u32> for uint24

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 UpperExp for uint24

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

Formats the value using the given formatter.

impl UpperHex for uint24

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

Formats the value using the given formatter.