pub struct u5(/* private fields */);
Expand description
The 5-bit unsigned integer type.
Implementations§
source§impl u5
impl u5
sourcepub fn min_value() -> u5
pub fn min_value() -> u5
Returns the smallest value that can be represented by this integer type.
sourcepub fn max_value() -> u5
pub fn max_value() -> u5
Returns the largest value that can be represented by this integer type.
sourcepub const fn new(value: u8) -> u5
pub const fn new(value: u8) -> u5
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 u5
impl BitAndAssign for u5
source§fn bitand_assign(&mut self, other: u5)
fn bitand_assign(&mut self, other: u5)
Performs the
&=
operation. Read moresource§impl BitOrAssign for u5
impl BitOrAssign for u5
source§fn bitor_assign(&mut self, other: u5)
fn bitor_assign(&mut self, other: u5)
Performs the
|=
operation. Read moresource§impl BitXorAssign for u5
impl BitXorAssign for u5
source§fn bitxor_assign(&mut self, other: u5)
fn bitxor_assign(&mut self, other: u5)
Performs the
^=
operation. Read moresource§impl Ord for u5
impl Ord for u5
source§impl PartialEq for u5
impl PartialEq for u5
source§impl PartialOrd for u5
impl PartialOrd for u5
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 u5
impl<T> ShlAssign<T> for u5
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 u5
impl<T> ShrAssign<T> for u5
source§fn shr_assign(&mut self, rhs: T)
fn shr_assign(&mut self, rhs: T)
Performs the
>>=
operation. Read moreimpl Copy for u5
impl Eq for u5
Auto Trait Implementations§
impl Freeze for u5
impl RefUnwindSafe for u5
impl Send for u5
impl Sync for u5
impl Unpin for u5
impl UnwindSafe for u5
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