Struct u24

pub struct u24(pub u32);

Unsigned 24 bit integer explicit type. You should really only use this when you need to derive the BinaryIo trait as it is a helper type.

Example

use binary_util::types::u24;
use binary_util::BinaryIo;

#[derive(BinaryIo)]
struct MyStruct {
   test: u24,
}

Tuple Fields

0: u32

Implementations

impl u24

pub fn new(val: u32) -> Self

Methods from Deref<Target = u32>

pub const MIN: u32 = 0u32

pub const MAX: u32 = 4_294_967_295u32

pub const BITS: u32 = 32u32

Trait Implementations

impl Clone for u24

fn clone(&self) -> u24

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for u24

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

Formats the value using the given formatter.

impl Deref for u24

type Target = u32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for u24

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for u24

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

Formats the value using the given formatter.

impl From<BE<u24>> for u24

fn from(val: BE<u24>) -> Self

Converts to this type from the input type.

impl From<LE<u24>> for u24

fn from(val: LE<u24>) -> Self

Converts to this type from the input type.

impl From<u24> for BE<u24>

fn from(val: u24) -> Self

Converts to this type from the input type.

impl From<u24> for LE<u24>

fn from(val: u24) -> Self

Converts to this type from the input type.

impl From<u24> for u32

fn from(val: u24) -> Self

Converts to this type from the input type.

impl From<u32> for u24

fn from(val: u32) -> Self

Converts to this type from the input 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 Ord for u24

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

impl PartialEq for u24

fn eq(&self, other: &u24) -> 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 PartialOrd for u24

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

fn read(buf: &mut ByteReader) -> Result<u24, Error>

Reads Self from a ByteReader.

fn read_from_slice(buf: &[u8]) -> Result<Output, Error>

Reads Self from a &[u8].

impl Writer for u24

fn write(&self, buf: &mut ByteWriter) -> Result<(), Error>

Writes Self to a ByteWriter.

fn write_to_bytes(&self) -> Result<ByteWriter, Error>

This is a utility function to write Self to a ByteWriter without needing to create a ByteWriter first.

impl Copy for u24

impl Eq for u24

impl StructuralPartialEq for u24