Struct js_int::Int

pub struct Int(_);

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

Methods

impl Int

pub const MIN: Self

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

Examples

Basic usage:

assert_eq!(Int::MIN, Int::try_from(-9_007_199_254_740_991i64).unwrap());

pub const MAX: Self

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

Examples

Basic usage:

assert_eq!(Int::MAX, Int::try_from(9_007_199_254_740_991i64).unwrap());

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

Try to create an Int from the provided i64, returning None if it is smaller than MIN_SAFE_INT or larger than MAX_SAFE_INT.

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

Examples

Basic usage:

assert_eq!(Int::new(js_int::MIN_SAFE_INT), Some(Int::MIN));
assert_eq!(Int::new(js_int::MAX_SAFE_INT), Some(Int::MAX));
assert_eq!(Int::new(js_int::MIN_SAFE_INT - 1), None);
assert_eq!(Int::new(js_int::MAX_SAFE_INT + 1), 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 + or - 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!(Int::from_str_radix("A", 16), Ok(Int::from(10)));

#[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!(Int::min_value(), Int::try_from(-9_007_199_254_740_991i64).unwrap());

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

Deprecated:

Use Int::MAX instead.

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

Examples

Basic usage:

assert_eq!(Int::max_value(), Int::try_from(9_007_199_254_740_991i64).unwrap());

#[must_use]pub fn abs(self) -> Self

Computes the absolute value of self.

Examples

Basic usage:

assert_eq!(Int::from(10).abs(), Int::from(10));
assert_eq!(Int::from(-10).abs(), Int::from(10));

// Differently from i8 / i16 / i32 / i128, Int's min_value is its max_value negated
assert_eq!(Int::MIN.abs(), Int::MAX);

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

Returns true if self is positive and false if the number is zero or negative.

Examples

Basic usage:

assert!(Int::from(10).is_positive());
assert!(!Int::from(0).is_positive());
assert!(!Int::from(-10).is_positive());

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

Returns true if self is negative and false if the number is zero or positive.

Examples

Basic usage:

assert!(Int::from(-10).is_negative());
assert!(!Int::from(0).is_negative());
assert!(!Int::from(10).is_negative());

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

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

Examples

Basic usage:

assert_eq!(
    (Int::MAX - Int::from(1)).checked_add(Int::from(1)),
    Some(Int::MAX)
);
assert_eq!((Int::MAX - Int::from(1)).checked_add(Int::from(2)), 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!(
    (Int::MIN + Int::from(2)).checked_sub(Int::from(1)),
    Some(Int::MIN + Int::from(1))
);
assert_eq!((Int::MIN + Int::from(2)).checked_sub(Int::from(3)), 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!(Int::from(5).checked_mul(Int::from(1)), Some(Int::from(5)));
assert_eq!(Int::MAX.checked_mul(Int::from(2)), 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!(Int::MIN.checked_div(Int::from(-1)), Some(Int::MAX));
assert_eq!(Int::from(1).checked_div(Int::from(0)), 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!(Int::from(5).checked_rem(Int::from(2)), Some(Int::from(1)));
assert_eq!(Int::from(5).checked_rem(Int::from(0)), None);
assert_eq!(Int::MIN.checked_rem(Int::from(-1)), Some(Int::from(0)));

#[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!(Int::from(8).checked_pow(2), Some(Int::from(64)));
assert_eq!(Int::MAX.checked_pow(2), None);
assert_eq!(Int::MIN.checked_pow(2), None);
assert_eq!(Int::from(1_000_000_000).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!(Int::from(100).saturating_add(Int::from(1)), Int::from(101));
assert_eq!(Int::MAX.saturating_add(Int::from(1)), Int::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!(Int::from(100).saturating_sub(Int::from(1)), Int::from(99));
assert_eq!(Int::MIN.saturating_sub(Int::from(1)), Int::MIN);

#[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!(Int::from(100).saturating_mul(Int::from(2)), Int::from(200));
assert_eq!(Int::MAX.saturating_mul(Int::from(2)), Int::MAX);
assert_eq!(Int::MAX.saturating_mul(Int::MAX), Int::MAX);
assert_eq!(Int::MAX.saturating_mul(Int::MIN), Int::MIN);

#[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!(Int::from(5).saturating_pow(2), Int::from(25));
assert_eq!(Int::from(-2).saturating_pow(3), Int::from(-8));
assert_eq!(Int::MAX.saturating_pow(2), Int::MAX);
assert_eq!(Int::MIN.saturating_pow(2), Int::MAX);

Trait Implementations

impl Add<Int> for Int

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Int> for Int

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Int

fn clone(&self) -> Int

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Int

impl Debug for Int

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

Formats the value using the given formatter.

impl Default for Int

fn default() -> Int

Returns the "default value" for a type.

impl Display for Int

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

Formats the value using the given formatter.

impl Div<Int> for Int

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<Int> for Int

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl Eq for Int

impl From<Int> for i64

fn from(val: Int) -> Self

Performs the conversion.

impl From<Int> for i128

fn from(val: Int) -> Self

Performs the conversion.

impl From<Int> for f64

fn from(val: Int) -> Self

Performs the conversion.

impl From<i16> for Int

fn from(val: i16) -> Self

Performs the conversion.

impl From<i32> for Int

fn from(val: i32) -> Self

Performs the conversion.

impl From<i8> for Int

fn from(val: i8) -> Self

Performs the conversion.

impl From<u16> for Int

fn from(val: u16) -> Self

Performs the conversion.

impl From<u32> for Int

fn from(val: u32) -> Self

Performs the conversion.

impl From<u8> for Int

fn from(val: u8) -> Self

Performs the conversion.

impl FromStr for Int

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 Int

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<Int> for Int

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Int> for Int

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Neg for Int

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Int

fn cmp(&self, other: &Int) -> 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<Int> for Int

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

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

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

This method tests for !=.

impl PartialOrd<Int> for Int

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

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

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

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

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

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

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

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

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

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

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

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

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

impl Product<Int> for Int

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

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

impl Rem<Int> for Int

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<Int> for Int

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl StructuralEq for Int

impl StructuralPartialEq for Int

impl Sub<Int> for Int

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Int> for Int

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

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

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

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

impl Sum<Int> for Int

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

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

impl TryFrom<Int> for i8

type Error = StdTryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Int> for i16

type Error = StdTryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Int> for i32

type Error = StdTryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i128> for Int

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<i64> for Int

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<u128> for Int

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 Int

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.