Struct bit_struct::u24

pub struct u24(_);

An unsigned integer which contains 24 bits

Implementations

impl u24

pub const MAX: u32 = 16_777_215u32

The largest value that can be stored

pub const MIN: u32 = 0u32

The smallest value that can be stored

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

Create a new u24 from an inner value

This method does not do any checks that the value passed is valid. To check that, use the u24::new function.

Safety

The value must be valid value of the given type.

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

Create a new u24 from an inner value

This method checks that the inner value is valid, and return None if it isn’t.

pub const fn value(self) -> u32

Get the stored value

impl u24

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

Convert from an array of bytes, in big-endian order

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

Convert self into an array of bytes, in big-endian order

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

Convert from an array of bytes, in little-endian order

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

Convert self into an array of bytes, in little-endian order

Trait Implementations

impl Add<u24> for u24

type Output = u24

The resulting type after applying the + operator.

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

Performs the + operation.

impl BitAnd<u24> for u24

type Output = u24

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<u24> for u24

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitCount for u24

const COUNT: usize = 24usize

The number of bits this type takes up

Note that this is the conceptual amount it needs in a bit struct, not the amount it will use as its own variable on the stack.

impl BitOr<u24> for u24

type Output = u24

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<u24> for u24

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<u24> for u24

type Output = u24

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<u24> for u24

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl BitsFitIn<u24> for bool

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i10

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i11

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i12

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i13

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i14

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i15

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i16

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i17

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i18

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i19

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i2

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i20

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i21

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i22

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i23

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i3

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i4

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i5

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i6

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i7

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i8

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for i9

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u1

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u10

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u11

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u12

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u13

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u14

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u15

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u16

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u17

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u18

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u19

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u2

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u20

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u21

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u22

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u23

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u24

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u3

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u4

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u5

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u6

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u7

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u8

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u24> for u9

fn fit(self) -> u24

Fits self into the target type

impl BitsFitIn<u25> for u24

fn fit(self) -> u25

Fits self into the target type

impl BitsFitIn<u26> for u24

fn fit(self) -> u26

Fits self into the target type

impl BitsFitIn<u27> for u24

fn fit(self) -> u27

Fits self into the target type

impl BitsFitIn<u28> for u24

fn fit(self) -> u28

Fits self into the target type

impl BitsFitIn<u29> for u24

fn fit(self) -> u29

Fits self into the target type

impl BitsFitIn<u30> for u24

fn fit(self) -> u30

Fits self into the target type

impl BitsFitIn<u31> for u24

fn fit(self) -> u31

Fits self into the target type

impl BitsFitIn<u32> for u24

fn fit(self) -> u32

Fits self into the target type

impl BitsFitIn<u33> for u24

fn fit(self) -> u33

Fits self into the target type

impl BitsFitIn<u34> for u24

fn fit(self) -> u34

Fits self into the target type

impl BitsFitIn<u35> for u24

fn fit(self) -> u35

Fits self into the target type

impl BitsFitIn<u36> for u24

fn fit(self) -> u36

Fits self into the target type

impl BitsFitIn<u37> for u24

fn fit(self) -> u37

Fits self into the target type

impl BitsFitIn<u38> for u24

fn fit(self) -> u38

Fits self into the target type

impl BitsFitIn<u39> for u24

fn fit(self) -> u39

Fits self into the target type

impl BitsFitIn<u40> for u24

fn fit(self) -> u40

Fits self into the target type

impl BitsFitIn<u41> for u24

fn fit(self) -> u41

Fits self into the target type

impl BitsFitIn<u42> for u24

fn fit(self) -> u42

Fits self into the target type

impl BitsFitIn<u43> for u24

fn fit(self) -> u43

Fits self into the target type

impl BitsFitIn<u44> for u24

fn fit(self) -> u44

Fits self into the target type

impl BitsFitIn<u45> for u24

fn fit(self) -> u45

Fits self into the target type

impl BitsFitIn<u46> for u24

fn fit(self) -> u46

Fits self into the target type

impl BitsFitIn<u47> for u24

fn fit(self) -> u47

Fits self into the target type

impl BitsFitIn<u48> for u24

fn fit(self) -> u48

Fits self into the target type

impl BitsFitIn<u49> for u24

fn fit(self) -> u49

Fits self into the target type

impl BitsFitIn<u50> for u24

fn fit(self) -> u50

Fits self into the target type

impl BitsFitIn<u51> for u24

fn fit(self) -> u51

Fits self into the target type

impl BitsFitIn<u52> for u24

fn fit(self) -> u52

Fits self into the target type

impl BitsFitIn<u53> for u24

fn fit(self) -> u53

Fits self into the target type

impl BitsFitIn<u54> for u24

fn fit(self) -> u54

Fits self into the target type

impl BitsFitIn<u55> for u24

fn fit(self) -> u55

Fits self into the target type

impl BitsFitIn<u56> for u24

fn fit(self) -> u56

Fits self into the target type

impl BitsFitIn<u57> for u24

fn fit(self) -> u57

Fits self into the target type

impl BitsFitIn<u58> for u24

fn fit(self) -> u58

Fits self into the target type

impl BitsFitIn<u59> for u24

fn fit(self) -> u59

Fits self into the target type

impl BitsFitIn<u60> for u24

fn fit(self) -> u60

Fits self into the target type

impl BitsFitIn<u61> for u24

fn fit(self) -> u61

Fits self into the target type

impl BitsFitIn<u62> for u24

fn fit(self) -> u62

Fits self into the target type

impl BitsFitIn<u63> for u24

fn fit(self) -> u63

Fits self into the target type

impl BitsFitIn<u64> for u24

fn fit(self) -> u64

Fits self into the target type

impl Bounded for u24

fn min_value() -> Self

Returns the smallest finite number this type can represent

fn max_value() -> Self

Returns the largest finite number this type can represent

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

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for u24

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for u24

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

Formats the value using the given formatter.

impl Div<u24> for u24

type Output = u24

The resulting type after applying the / operator.

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

Performs the / operation.

impl FieldStorage for u24

type StoredType = u32

The type this field stores as

fn inner_raw(self) -> Self::StoredType

Get the raw representation of this value

impl From<u8> for u24

fn from(byte: u8) -> Self

Converts to this type from the input type.

impl FromStr for u24

type Err = <u24 as Num>::FromStrRadixErr

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

type Output = u24

The resulting type after applying the * operator.

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

Performs the * operation.

impl Num for u24

type FromStrRadixErr = ()

fn from_str_radix(str: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl One for u24

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> boolwhere
Self: PartialEq<Self>,

Returns true if self is equal to the multiplicative identity.

impl Ord for u24

fn cmp(&self, other: &u24) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<u24> for u24

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<u24> 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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem<u24> for u24

type Output = u24

The resulting type after applying the % operator.

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

Performs the % operation.

impl Serialize for u24

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer.

impl Shl<usize> for u24

type Output = u24

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation.

impl ShlAssign<usize> for u24

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for u24

type Output = u24

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl ShrAssign<usize> for u24

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub<u24> for u24

type Output = u24

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P> ValidCheck<P> for u24

const ALWAYS_VALID: bool = true

Set this to true if, at compile-time, we can tell that all bit representations which contain the appropriate number of bits are valid representations of this type

fn is_valid(_input: P) -> bool

Return whether or not the underlying bits of P are valid representation of this type

impl Zero for u24

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for u24

impl Eq for u24

impl StructuralEq for u24

impl StructuralPartialEq for u24