Struct js_int::UInt

pub struct UInt(_);

An integer limited to the range of non-negative integers that can be represented exactly by an f64.

Methods

impl UInt

pub const MIN: Self

The smallest value that can be represented by this integer type.

Examples

Basic usage:

assert_eq!(UInt::MIN, UInt::from(0u32));

pub const MAX: Self

The largest value that can be represented by this integer type.

Examples

Basic usage:

assert_eq!(UInt::MAX, UInt::try_from(9_007_199_254_740_991u64).unwrap());

#[must_use]pub fn new(val: u64) -> Option<Self>

Try to create a UInt from the provided u64, returning None if it is larger than MAX_SAFE_UINT.

This is the same as the TryFrom<u64> implementation for UInt, except that it returns an Option instead of a Result.

Examples

Basic usage:

assert_eq!(UInt::new(js_int::MAX_SAFE_UINT), Some(UInt::MAX));
assert_eq!(UInt::new(js_int::MAX_SAFE_UINT + 1), None);

#[must_use]pub fn new_wrapping(val: u64) -> Self

Create a UInt from the provided u64, wrapping at MAX_SAFE_UINT.

Examples

Basic usage:

assert_eq!(UInt::new_wrapping(js_int::MAX_SAFE_UINT), UInt::MAX);
assert_eq!(UInt::new_wrapping(js_int::MAX_SAFE_UINT + 1), UInt::from(0u32));

#[must_use]pub const fn min_value() -> Self

Deprecated:

Use UInt::MIN instead.

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

Examples

Basic usage:

assert_eq!(UInt::min_value(), UInt::from(0u32));

#[must_use]pub const fn max_value() -> Self

Deprecated:

Use UInt::MAX instead.

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

Examples

Basic usage:

assert_eq!(UInt::max_value(), UInt::try_from(9_007_199_254_740_991u64).unwrap());

#[must_use]pub fn is_power_of_two(self) -> bool

Returns true if and only if self == 2^k for some k.

Examples

Basic usage:

assert!(UInt::from(16u32).is_power_of_two());
assert!(!UInt::from(10u32).is_power_of_two());

#[must_use]pub fn checked_next_power_of_two(self) -> Option<Self>

Returns the smallest power of two greater than or equal to n. If the next power of two is greater than the type's maximum value, None is returned, otherwise the power of two is wrapped in Some.

Examples

Basic usage:

assert_eq!(UInt::from(2u32).checked_next_power_of_two(), Some(UInt::from(2u32)));
assert_eq!(UInt::from(3u32).checked_next_power_of_two(), Some(UInt::from(4u32)));
assert_eq!(UInt::MAX.checked_next_power_of_two(), None);

pub fn from_str_radix(src: &str, radix: u32) -> Result<Self, ParseIntError>

Converts a string slice in a given base to an integer.

The string is expected to be an optional + sign followed by digits. Leading and trailing whitespace represent an error. Digits are a subset of these characters, depending on radix:

• 0-9
• a-z
• A-Z

Panics

This function panics if radix is not in the range from 2 to 36.

Examples

Basic usage:

assert_eq!(UInt::from_str_radix("A", 16), Ok(UInt::from(10u32)));

#[must_use]pub fn checked_add(self, rhs: Self) -> Option<Self>

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

assert_eq!(
    (UInt::MAX - UInt::from(2u32)).checked_add(UInt::from(1u32)),
    Some(UInt::MAX - UInt::from(1u32))
);
assert_eq!((UInt::MAX - UInt::from(2u32)).checked_add(UInt::from(3u32)), None);

#[must_use]pub fn checked_sub(self, rhs: Self) -> Option<Self>

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!(UInt::from(1u32).checked_sub(UInt::from(1u32)), Some(UInt::from(0u32)));
assert_eq!(UInt::from(0u32).checked_sub(UInt::from(1u32)), None);

#[must_use]pub fn checked_mul(self, rhs: Self) -> Option<Self>

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!(UInt::from(5u32).checked_mul(UInt::from(1u32)), Some(UInt::from(5u32)));
assert_eq!(UInt::MAX.checked_mul(UInt::from(2u32)), None);

#[must_use]pub fn checked_div(self, rhs: Self) -> Option<Self>

Checked integer division. Computes self / rhs, returning None if rhs == 0.

Examples

Basic usage:

assert_eq!(UInt::from(128u32).checked_div(UInt::from(2u32)), Some(UInt::from(64u32)));
assert_eq!(UInt::from(1u32).checked_div(UInt::from(0u32)), None);

#[must_use]pub fn checked_rem(self, rhs: Self) -> Option<Self>

Checked integer remainder. Computes self % rhs, returning None if rhs == 0.

Examples

Basic usage:

assert_eq!(UInt::from(5u32).checked_rem(UInt::from(2u32)), Some(UInt::from(1u32)));
assert_eq!(UInt::from(5u32).checked_rem(UInt::from(0u32)), None);

#[must_use]pub fn checked_neg(self) -> Option<Self>

Checked negation. Computes -self, returning None unless self == 0.

Note that negating any positive integer will overflow.

Examples

Basic usage:

assert_eq!(UInt::from(0u32).checked_neg(), Some(UInt::from(0u32)));
assert_eq!(UInt::from(1u32).checked_neg(), None);

#[must_use]pub fn checked_pow(self, exp: u32) -> Option<Self>

Checked exponentiation. Computes self.pow(exp), returning None if overflow or underflow occurred.

Examples

Basic usage:

assert_eq!(UInt::from(0u32).checked_pow(2), Some(UInt::from(0u32)));
assert_eq!(UInt::from(8u32).checked_pow(2), Some(UInt::from(64u32)));
assert_eq!(UInt::from(1_000_000_000u32).checked_pow(2), None);
assert_eq!(UInt::MAX.checked_pow(2), None);

#[must_use]pub fn saturating_add(self, rhs: Self) -> Self

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(UInt::from(100u32).saturating_add(UInt::from(1u32)), UInt::from(101u32));
assert_eq!(UInt::MAX.saturating_add(UInt::from(1u32)), UInt::MAX);

#[must_use]pub fn saturating_sub(self, rhs: Self) -> Self

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of underflowing.

Examples

Basic usage:

assert_eq!(UInt::from(100u32).saturating_sub(UInt::from(1u32)), UInt::from(99u32));
assert_eq!(UInt::from(1u32).saturating_sub(UInt::from(2u32)), UInt::from(0u32));

#[must_use]pub fn saturating_mul(self, rhs: Self) -> Self

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(UInt::from(100u32).saturating_mul(UInt::from(2u32)), UInt::from(200u32));
assert_eq!(UInt::MAX.saturating_mul(UInt::from(2u32)), UInt::MAX);
assert_eq!(UInt::MAX.saturating_mul(UInt::MAX), UInt::MAX);

#[must_use]pub fn saturating_pow(self, exp: u32) -> Self

Saturating integer exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing or underflowing.

Examples

Basic usage:

assert_eq!(UInt::from(5u32).saturating_pow(2), UInt::from(25u32));
assert_eq!(UInt::MAX.saturating_pow(2), UInt::MAX);

Trait Implementations

impl Add<UInt> for UInt

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<UInt> for UInt

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for UInt

fn clone(&self) -> UInt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for UInt

impl Debug for UInt

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

Formats the value using the given formatter.

impl Default for UInt

fn default() -> UInt

Returns the "default value" for a type.

impl Display for UInt

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

Formats the value using the given formatter.

impl Div<UInt> for UInt

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<UInt> for UInt

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl Eq for UInt

impl From<UInt> for u64

fn from(val: UInt) -> Self

Performs the conversion.

impl From<UInt> for u128

fn from(val: UInt) -> Self

Performs the conversion.

impl From<UInt> for f64

fn from(val: UInt) -> Self

Performs the conversion.

impl From<u16> for UInt

fn from(val: u16) -> Self

Performs the conversion.

impl From<u32> for UInt

fn from(val: u32) -> Self

Performs the conversion.

impl From<u8> for UInt

fn from(val: u8) -> Self

Performs the conversion.

impl FromStr for UInt

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for UInt

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, 

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

impl Mul<UInt> for UInt

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<UInt> for UInt

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Ord for UInt

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<UInt> for UInt

fn eq(&self, other: &UInt) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UInt) -> bool

This method tests for !=.

impl PartialOrd<UInt> for UInt

fn partial_cmp(&self, other: &UInt) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &UInt) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &UInt) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &UInt) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &UInt) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Product<&'a UInt> for UInt

fn product<I>(iter: I) -> Self where
    I: Iterator<Item = &'a UInt>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Product<UInt> for UInt

fn product<I>(iter: I) -> Self where
    I: Iterator<Item = UInt>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Rem<UInt> for UInt

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<UInt> for UInt

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl StructuralEq for UInt

impl StructuralPartialEq for UInt

impl Sub<UInt> for UInt

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<UInt> for UInt

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<'a> Sum<&'a UInt> for UInt

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = &'a UInt>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl Sum<UInt> for UInt

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = UInt>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl TryFrom<UInt> for u8

type Error = StdTryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: UInt) -> Result<Self, StdTryFromIntError>

Performs the conversion.

impl TryFrom<UInt> for u16

type Error = StdTryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: UInt) -> Result<Self, StdTryFromIntError>

Performs the conversion.

impl TryFrom<UInt> for u32

type Error = StdTryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: UInt) -> Result<Self, StdTryFromIntError>

Performs the conversion.

impl TryFrom<i128> for UInt

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: i128) -> Result<Self, TryFromIntError>

Performs the conversion.

impl TryFrom<i16> for UInt

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: i16) -> Result<Self, TryFromIntError>

Performs the conversion.

impl TryFrom<i32> for UInt

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: i32) -> Result<Self, TryFromIntError>

Performs the conversion.

impl TryFrom<i64> for UInt

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: i64) -> Result<Self, TryFromIntError>

Performs the conversion.

impl TryFrom<i8> for UInt

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: i8) -> Result<Self, TryFromIntError>

Performs the conversion.

impl TryFrom<u128> for UInt

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: u128) -> Result<Self, TryFromIntError>

Performs the conversion.

impl TryFrom<u64> for UInt

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(val: u64) -> Result<Self, TryFromIntError>

Performs the conversion.