Struct ux::i24

pub struct i24(_);

The 24-bit signed integer type.

Methods

impl i24

The 24-bit signed integer type.

pub const MAX: Self

MAX: Self = i24(((1 as i32) << 24 - 1) - 1)

pub const MIN: Self

MIN: Self = i24(-((1 as i32) << 24 - 1))

impl i24

pub fn min_value() -> i24

Returns the smallest value that can be represented by this integer type.

pub fn max_value() -> i24

Returns the largest value that can be represented by this integer type.

pub fn new(value: i32) -> i24

Crates a new variable

This function mainly exists as there is currently not a better way to construct these types. May be deprecated or removed if a better way to construct these types becomes available.

Examples

Basic usage:

use ux::*;

assert_eq!(u31::new(64), u31::from(64u8));

Panic

This function will panic if value is not representable by this type

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

Wrapping (modular) subtraction. Computes self - other, wrapping around at the boundary of the type.

Examples

Basic usage:

use ux::*;

assert_eq!(i5::MIN.wrapping_sub(i5::new(1)), i5::MAX);

assert_eq!(i5::new(-10).wrapping_sub(i5::new(5)), i5::new(-15));
assert_eq!(i5::new(-15).wrapping_sub(i5::new(5)), i5::new(12));

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

Wrapping (modular) addition. Computes self + other, wrapping around at the boundary of the type.

Examples

Basic usage:

use ux::*;

assert_eq!(i5::MAX.wrapping_add(i5::new(1)), i5::MIN);

assert_eq!(i5::new(10).wrapping_add(i5::new(5)), i5::new(15));
assert_eq!(i5::new(15).wrapping_add(i5::new(5)), i5::new(-12));

Trait Implementations

impl From<i8> for i24

fn from(x: i8) -> i24

Performs the conversion.

impl From<i16> for i24

fn from(x: i16) -> i24

Performs the conversion.

impl From<i24> for i32

fn from(x: i24) -> i32

Performs the conversion.

impl From<i24> for i64

fn from(x: i24) -> i64

Performs the conversion.

impl From<i2> for i24

fn from(x: i2) -> i24

Performs the conversion.

impl From<i3> for i24

fn from(x: i3) -> i24

Performs the conversion.

impl From<i4> for i24

fn from(x: i4) -> i24

Performs the conversion.

impl From<i5> for i24

fn from(x: i5) -> i24

Performs the conversion.

impl From<i6> for i24

fn from(x: i6) -> i24

Performs the conversion.

impl From<i7> for i24

fn from(x: i7) -> i24

Performs the conversion.

impl From<i9> for i24

fn from(x: i9) -> i24

Performs the conversion.

impl From<i10> for i24

fn from(x: i10) -> i24

Performs the conversion.

impl From<i11> for i24

fn from(x: i11) -> i24

Performs the conversion.

impl From<i12> for i24

fn from(x: i12) -> i24

Performs the conversion.

impl From<i13> for i24

fn from(x: i13) -> i24

Performs the conversion.

impl From<i14> for i24

fn from(x: i14) -> i24

Performs the conversion.

impl From<i15> for i24

fn from(x: i15) -> i24

Performs the conversion.

impl From<i17> for i24

fn from(x: i17) -> i24

Performs the conversion.

impl From<i18> for i24

fn from(x: i18) -> i24

Performs the conversion.

impl From<i19> for i24

fn from(x: i19) -> i24

Performs the conversion.

impl From<i20> for i24

fn from(x: i20) -> i24

Performs the conversion.

impl From<i21> for i24

fn from(x: i21) -> i24

Performs the conversion.

impl From<i22> for i24

fn from(x: i22) -> i24

Performs the conversion.

impl From<i23> for i24

fn from(x: i23) -> i24

Performs the conversion.

impl From<i24> for i25

fn from(x: i24) -> i25

Performs the conversion.

impl From<i24> for i26

fn from(x: i24) -> i26

Performs the conversion.

impl From<i24> for i27

fn from(x: i24) -> i27

Performs the conversion.

impl From<i24> for i28

fn from(x: i24) -> i28

Performs the conversion.

impl From<i24> for i29

fn from(x: i24) -> i29

Performs the conversion.

impl From<i24> for i30

fn from(x: i24) -> i30

Performs the conversion.

impl From<i24> for i31

fn from(x: i24) -> i31

Performs the conversion.

impl From<i24> for i33

fn from(x: i24) -> i33

Performs the conversion.

impl From<i24> for i34

fn from(x: i24) -> i34

Performs the conversion.

impl From<i24> for i35

fn from(x: i24) -> i35

Performs the conversion.

impl From<i24> for i36

fn from(x: i24) -> i36

Performs the conversion.

impl From<i24> for i37

fn from(x: i24) -> i37

Performs the conversion.

impl From<i24> for i38

fn from(x: i24) -> i38

Performs the conversion.

impl From<i24> for i39

fn from(x: i24) -> i39

Performs the conversion.

impl From<i24> for i40

fn from(x: i24) -> i40

Performs the conversion.

impl From<i24> for i41

fn from(x: i24) -> i41

Performs the conversion.

impl From<i24> for i42

fn from(x: i24) -> i42

Performs the conversion.

impl From<i24> for i43

fn from(x: i24) -> i43

Performs the conversion.

impl From<i24> for i44

fn from(x: i24) -> i44

Performs the conversion.

impl From<i24> for i45

fn from(x: i24) -> i45

Performs the conversion.

impl From<i24> for i46

fn from(x: i24) -> i46

Performs the conversion.

impl From<i24> for i47

fn from(x: i24) -> i47

Performs the conversion.

impl From<i24> for i48

fn from(x: i24) -> i48

Performs the conversion.

impl From<i24> for i49

fn from(x: i24) -> i49

Performs the conversion.

impl From<i24> for i50

fn from(x: i24) -> i50

Performs the conversion.

impl From<i24> for i51

fn from(x: i24) -> i51

Performs the conversion.

impl From<i24> for i52

fn from(x: i24) -> i52

Performs the conversion.

impl From<i24> for i53

fn from(x: i24) -> i53

Performs the conversion.

impl From<i24> for i54

fn from(x: i24) -> i54

Performs the conversion.

impl From<i24> for i55

fn from(x: i24) -> i55

Performs the conversion.

impl From<i24> for i56

fn from(x: i24) -> i56

Performs the conversion.

impl From<i24> for i57

fn from(x: i24) -> i57

Performs the conversion.

impl From<i24> for i58

fn from(x: i24) -> i58

Performs the conversion.

impl From<i24> for i59

fn from(x: i24) -> i59

Performs the conversion.

impl From<i24> for i60

fn from(x: i24) -> i60

Performs the conversion.

impl From<i24> for i61

fn from(x: i24) -> i61

Performs the conversion.

impl From<i24> for i62

fn from(x: i24) -> i62

Performs the conversion.

impl From<i24> for i63

fn from(x: i24) -> i63

Performs the conversion.

impl Default for i24

fn default() -> i24

Returns the "default value" for a type.

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

impl Debug for i24

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for i24

fn eq(&self, other: &Self) -> 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 !=.

impl Eq for i24

impl PartialOrd for i24

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Hash for i24

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Display for i24

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

Formats the value using the given formatter.

impl UpperHex for i24

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

Formats the value using the given formatter.

impl LowerHex for i24

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

Formats the value using the given formatter.

impl Octal for i24

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

Formats the value using the given formatter.

impl Binary for i24

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

Formats the value using the given formatter.

impl<T> Shr<T> for i24 where
    i32: Shr<T, Output = i32>, 

type Output = i24

The resulting type after applying the >> operator.

fn shr(self, rhs: T) -> i24

Performs the >> operation.

impl<T> Shl<T> for i24 where
    i32: Shl<T, Output = i32>, 

type Output = i24

The resulting type after applying the << operator.

fn shl(self, rhs: T) -> i24

Performs the << operation.

impl<T> ShrAssign<T> for i24 where
    i32: ShrAssign<T>, 

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T> ShlAssign<T> for i24 where
    i32: ShlAssign<T>, 

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl BitOr<i24> for i24

type Output = i24

The resulting type after applying the | operator.

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

Performs the | operation.

impl<'a> BitOr<&'a i24> for i24

type Output = <i24 as BitOr<i24>>::Output

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a i24) -> Self::Output

Performs the | operation.

impl<'a> BitOr<i24> for &'a i24

type Output = <i24 as BitOr<i24>>::Output

The resulting type after applying the | operator.

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

Performs the | operation.

impl<'a> BitOr<&'a i24> for &'a i24

type Output = <i24 as BitOr<i24>>::Output

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a i24) -> Self::Output

Performs the | operation.

impl BitOrAssign<i24> for i24

fn bitor_assign(&mut self, other: i24)

Performs the |= operation.

impl BitXor<i24> for i24

type Output = i24

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<'a> BitXor<&'a i24> for i24

type Output = <i24 as BitOr<i24>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a i24) -> Self::Output

Performs the ^ operation.

impl<'a> BitXor<i24> for &'a i24

type Output = <i24 as BitOr<i24>>::Output

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<'a> BitXor<&'a i24> for &'a i24

type Output = <i24 as BitOr<i24>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a i24) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<i24> for i24

fn bitxor_assign(&mut self, other: i24)

Performs the ^= operation.

impl Not for i24

type Output = i24

The resulting type after applying the ! operator.

fn not(self) -> i24

Performs the unary ! operation.

impl<'a> Not for &'a i24

type Output = <i24 as Not>::Output

The resulting type after applying the ! operator.

fn not(self) -> i24

Performs the unary ! operation.

impl BitAnd<i24> for i24

type Output = i24

The resulting type after applying the & operator.

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

Performs the & operation.

impl<'a> BitAnd<&'a i24> for i24

type Output = <i24 as BitOr<i24>>::Output

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a i24) -> Self::Output

Performs the & operation.

impl<'a> BitAnd<i24> for &'a i24

type Output = <i24 as BitOr<i24>>::Output

The resulting type after applying the & operator.

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

Performs the & operation.

impl<'a> BitAnd<&'a i24> for &'a i24

type Output = <i24 as BitOr<i24>>::Output

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a i24) -> Self::Output

Performs the & operation.

impl BitAndAssign<i24> for i24

fn bitand_assign(&mut self, other: i24)

Performs the &= operation.

impl Add<i24> for i24

type Output = i24

The resulting type after applying the + operator.

fn add(self, other: i24) -> i24

Performs the + operation.

impl Sub<i24> for i24

type Output = i24

The resulting type after applying the - operator.

fn sub(self, other: i24) -> i24

Performs the - operation.