pub struct i24(/* private fields */);
Expand description
The 24-bit signed integer type.
Implementations§
source§impl i24
impl i24
sourcepub fn min_value() -> i24
pub fn min_value() -> i24
Returns the smallest value that can be represented by this integer type.
sourcepub fn max_value() -> i24
pub fn max_value() -> i24
Returns the largest value that can be represented by this integer type.
sourcepub const fn new(value: i32) -> i24
pub const 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
sourcepub fn wrapping_sub(self, rhs: Self) -> Self
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));
sourcepub fn wrapping_add(self, rhs: Self) -> Self
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§
source§impl BitAndAssign for i24
impl BitAndAssign for i24
source§fn bitand_assign(&mut self, other: i24)
fn bitand_assign(&mut self, other: i24)
Performs the
&=
operation. Read moresource§impl BitOrAssign for i24
impl BitOrAssign for i24
source§fn bitor_assign(&mut self, other: i24)
fn bitor_assign(&mut self, other: i24)
Performs the
|=
operation. Read moresource§impl BitXorAssign for i24
impl BitXorAssign for i24
source§fn bitxor_assign(&mut self, other: i24)
fn bitxor_assign(&mut self, other: i24)
Performs the
^=
operation. Read moresource§impl Ord for i24
impl Ord for i24
source§impl PartialEq for i24
impl PartialEq for i24
source§impl PartialOrd for i24
impl PartialOrd for i24
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moresource§impl<T> ShlAssign<T> for i24
impl<T> ShlAssign<T> for i24
source§fn shl_assign(&mut self, rhs: T)
fn shl_assign(&mut self, rhs: T)
Performs the
<<=
operation. Read moresource§impl<T> ShrAssign<T> for i24
impl<T> ShrAssign<T> for i24
source§fn shr_assign(&mut self, rhs: T)
fn shr_assign(&mut self, rhs: T)
Performs the
>>=
operation. Read moreimpl Copy for i24
impl Eq for i24
Auto Trait Implementations§
impl Freeze for i24
impl RefUnwindSafe for i24
impl Send for i24
impl Sync for i24
impl Unpin for i24
impl UnwindSafe for i24
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more