[−][src]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`[src]

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

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_value()));
assert_eq!(Int::new(js_int::MAX_SAFE_INT), Some(Int::max_value()));
assert_eq!(Int::new(js_int::MIN_SAFE_INT - 1), None);
assert_eq!(Int::new(js_int::MAX_SAFE_INT + 1), None);

`#[must_use] pub fn from_str_radix(src: &str, radix: u32) -> Result<Self, ParseIntError>`[src]

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`[src]

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`[src]

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`[src]

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_value().abs(), Int::max_value());

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

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`[src]

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>`[src]

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

Examples

Basic usage:

assert_eq!(
    (Int::max_value() - Int::from(1)).checked_add(Int::from(1)),
    Some(Int::max_value())
);

assert_eq!(
    (Int::max_value() - Int::from(1)).checked_add(Int::from(2)),
    None
);

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

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

Examples

Basic usage:

assert_eq!(
    (Int::min_value() + Int::from(2)).checked_sub(Int::from(1)),
    Some(Int::min_value() + Int::from(1))
);
assert_eq!((Int::min_value() + Int::from(2)).checked_sub(Int::from(3)), None);

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

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_value().checked_mul(Int::from(2)), None);

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

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

Examples

Basic usage:

assert_eq!(Int::min_value().checked_div(Int::from(-1)), Some(Int::max_value()));
assert_eq!(Int::from(1).checked_div(Int::from(0)), None);

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

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_value().checked_rem(Int::from(-1)), Some(Int::from(0)));

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

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_value().checked_pow(2), None);
assert_eq!(Int::min_value().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`[src]

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_value().saturating_add(Int::from(1)), Int::max_value());

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

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_value().saturating_sub(Int::from(1)), Int::min_value());

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

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_value().saturating_mul(Int::from(2)), Int::max_value());
assert_eq!(Int::max_value().saturating_mul(Int::max_value()), Int::max_value());
assert_eq!(Int::max_value().saturating_mul(Int::min_value()), Int::min_value());

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

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_value().saturating_pow(2), Int::max_value());
assert_eq!(Int::min_value().saturating_pow(2), Int::max_value());