Struct bit_struct::i24

pub struct i24(_);

An unsigned integer which contains 24 bits

Implementations

impl i24

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

Create a new $name from value

Safety

• value must fit within the number of bits defined in the type

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

Create a new $name from value

Safety

• value must fit within the number of bits defined in the type

pub const MAX: i32 = 8_388_607i32

The largest value this type can hold

pub const MIN: i32 = -8_388_608i32

The smallest value this type can hold

pub const fn value(self) -> i32

Get the value stored in here, as a signed integer

impl i24

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<i24> for i24

type Output = i24

The resulting type after applying the + operator.

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

Performs the + operation.

impl BitAnd<i24> for i24

type Output = i24

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<i24> for i24

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitCount for i24

const COUNT: usize = 24usize

The number of bits associated with this type

impl BitOr<i24> for i24

type Output = i24

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<i24> for i24

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<i24> for i24

type Output = i24

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<i24> for i24

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl BitsFitIn<u25> for i24

fn fit(self) -> u25

Fits self into the target type

impl BitsFitIn<u26> for i24

fn fit(self) -> u26

Fits self into the target type

impl BitsFitIn<u27> for i24

fn fit(self) -> u27

Fits self into the target type

impl BitsFitIn<u28> for i24

fn fit(self) -> u28

Fits self into the target type

impl BitsFitIn<u29> for i24

fn fit(self) -> u29

Fits self into the target type

impl BitsFitIn<u30> for i24

fn fit(self) -> u30

Fits self into the target type

impl BitsFitIn<u31> for i24

fn fit(self) -> u31

Fits self into the target type

impl BitsFitIn<u32> for i24

fn fit(self) -> u32

Fits self into the target type

impl BitsFitIn<u33> for i24

fn fit(self) -> u33

Fits self into the target type

impl BitsFitIn<u34> for i24

fn fit(self) -> u34

Fits self into the target type

impl BitsFitIn<u35> for i24

fn fit(self) -> u35

Fits self into the target type

impl BitsFitIn<u36> for i24

fn fit(self) -> u36

Fits self into the target type

impl BitsFitIn<u37> for i24

fn fit(self) -> u37

Fits self into the target type

impl BitsFitIn<u38> for i24

fn fit(self) -> u38

Fits self into the target type

impl BitsFitIn<u39> for i24

fn fit(self) -> u39

Fits self into the target type

impl BitsFitIn<u40> for i24

fn fit(self) -> u40

Fits self into the target type

impl BitsFitIn<u41> for i24

fn fit(self) -> u41

Fits self into the target type

impl BitsFitIn<u42> for i24

fn fit(self) -> u42

Fits self into the target type

impl BitsFitIn<u43> for i24

fn fit(self) -> u43

Fits self into the target type

impl BitsFitIn<u44> for i24

fn fit(self) -> u44

Fits self into the target type

impl BitsFitIn<u45> for i24

fn fit(self) -> u45

Fits self into the target type

impl BitsFitIn<u46> for i24

fn fit(self) -> u46

Fits self into the target type

impl BitsFitIn<u47> for i24

fn fit(self) -> u47

Fits self into the target type

impl BitsFitIn<u48> for i24

fn fit(self) -> u48

Fits self into the target type

impl BitsFitIn<u49> for i24

fn fit(self) -> u49

Fits self into the target type

impl BitsFitIn<u50> for i24

fn fit(self) -> u50

Fits self into the target type

impl BitsFitIn<u51> for i24

fn fit(self) -> u51

Fits self into the target type

impl BitsFitIn<u52> for i24

fn fit(self) -> u52

Fits self into the target type

impl BitsFitIn<u53> for i24

fn fit(self) -> u53

Fits self into the target type

impl BitsFitIn<u54> for i24

fn fit(self) -> u54

Fits self into the target type

impl BitsFitIn<u55> for i24

fn fit(self) -> u55

Fits self into the target type

impl BitsFitIn<u56> for i24

fn fit(self) -> u56

Fits self into the target type

impl BitsFitIn<u57> for i24

fn fit(self) -> u57

Fits self into the target type

impl BitsFitIn<u58> for i24

fn fit(self) -> u58

Fits self into the target type

impl BitsFitIn<u59> for i24

fn fit(self) -> u59

Fits self into the target type

impl BitsFitIn<u60> for i24

fn fit(self) -> u60

Fits self into the target type

impl BitsFitIn<u61> for i24

fn fit(self) -> u61

Fits self into the target type

impl BitsFitIn<u62> for i24

fn fit(self) -> u62

Fits self into the target type

impl BitsFitIn<u63> for i24

fn fit(self) -> u63

Fits self into the target type

impl BitsFitIn<u64> for i24

fn fit(self) -> u64

Fits self into the target type

impl Bounded for i24

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 i24

fn clone(&self) -> i24

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for i24

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

Formats the value using the given formatter.

impl Default for i24

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for i24

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

Deserialize this value from the given Serde deserializer.

impl Display for i24

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

Formats the value using the given formatter.

impl Div<i24> for i24

type Output = i24

The resulting type after applying the / operator.

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

Performs the / operation.

impl FieldStorage for i24

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 i24

fn from(byte: u8) -> Self

Converts to this type from the input type.

impl FromStr for i24

type Err = <i24 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 i24

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<i24> for i24

type Output = i24

The resulting type after applying the * operator.

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

Performs the * operation.

impl Num for i24

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 i24

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 i24

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

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

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

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<i24> for i24

type Output = i24

The resulting type after applying the % operator.

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

Performs the % operation.

impl Serialize for i24

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 i24

type Output = i24

The resulting type after applying the << operator.

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

Performs the << operation.

impl ShlAssign<usize> for i24

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for i24

type Output = i24

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl ShrAssign<usize> for i24

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub<i24> for i24

type Output = i24

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P> ValidCheck<P> for i24

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 i24

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 i24

impl Eq for i24

impl StructuralEq for i24

impl StructuralPartialEq for i24