pub struct i31(_);
Expand description
The 31-bit signed integer type.
Implementations
sourceimpl i31
impl i31
sourcepub fn min_value() -> i31
pub fn min_value() -> i31
Returns the smallest value that can be represented by this integer type.
sourcepub fn max_value() -> i31
pub fn max_value() -> i31
Returns the largest value that can be represented by this integer type.
sourcepub const fn new(value: i32) -> i31
pub const fn new(value: i32) -> i31
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
sourceimpl BitAndAssign<i31> for i31
impl BitAndAssign<i31> for i31
sourcefn bitand_assign(&mut self, other: i31)
fn bitand_assign(&mut self, other: i31)
Performs the &=
operation. Read more
sourceimpl BitOrAssign<i31> for i31
impl BitOrAssign<i31> for i31
sourcefn bitor_assign(&mut self, other: i31)
fn bitor_assign(&mut self, other: i31)
Performs the |=
operation. Read more
sourceimpl BitXorAssign<i31> for i31
impl BitXorAssign<i31> for i31
sourcefn bitxor_assign(&mut self, other: i31)
fn bitxor_assign(&mut self, other: i31)
Performs the ^=
operation. Read more
sourceimpl Ord for i31
impl Ord for i31
sourceimpl PartialOrd<i31> for i31
impl PartialOrd<i31> for i31
sourcefn partial_cmp(&self, other: &i31) -> Option<Ordering>
fn partial_cmp(&self, other: &i31) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn 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 more
sourceimpl<T> ShlAssign<T> for i31 where
i32: ShlAssign<T>,
impl<T> ShlAssign<T> for i31 where
i32: ShlAssign<T>,
sourcefn shl_assign(&mut self, rhs: T)
fn shl_assign(&mut self, rhs: T)
Performs the <<=
operation. Read more
sourceimpl<T> ShrAssign<T> for i31 where
i32: ShrAssign<T>,
impl<T> ShrAssign<T> for i31 where
i32: ShrAssign<T>,
sourcefn shr_assign(&mut self, rhs: T)
fn shr_assign(&mut self, rhs: T)
Performs the >>=
operation. Read more
impl Copy for i31
impl Eq for i31
Auto Trait Implementations
impl RefUnwindSafe for i31
impl Send for i31
impl Sync for i31
impl Unpin for i31
impl UnwindSafe for i31
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more