Primitive Type i128

impl i128

1.43.0 · source

pub const MIN: Self = -170_141_183_460_469_231_731_687_303_715_884_105_728i128

The smallest value that can be represented by this integer type (−2¹²⁷).

§Examples

Basic usage:

assert_eq!(i128::MIN, -170141183460469231731687303715884105728);

1.43.0 · source

pub const MAX: Self = 170_141_183_460_469_231_731_687_303_715_884_105_727i128

The largest value that can be represented by this integer type (2¹²⁷ − 1).

§Examples

Basic usage:

assert_eq!(i128::MAX, 170141183460469231731687303715884105727);

1.53.0 · source

pub const BITS: u32 = 128u32

The size of this integer type in bits.

§Examples

assert_eq!(i128::BITS, 128);

1.0.0 · source

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!(i128::from_str_radix("A", 16), Ok(10));

1.0.0 (const: 1.32.0) · source

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

§Examples

Basic usage:

let n = 0b100_0000i128;

assert_eq!(n.count_ones(), 1);

1.0.0 (const: 1.32.0) · source

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

§Examples

Basic usage:

assert_eq!(i128::MAX.count_zeros(), 1);

1.0.0 (const: 1.32.0) · source

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

Depending on what you’re doing with the value, you might also be interested in the ilog2 function which returns a consistent number, even if the type widens.

§Examples

Basic usage:

let n = -1i128;

assert_eq!(n.leading_zeros(), 0);

1.0.0 (const: 1.32.0) · source

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

§Examples

Basic usage:

let n = -4i128;

assert_eq!(n.trailing_zeros(), 2);

1.46.0 (const: 1.46.0) · source

pub const fn leading_ones(self) -> u32

Returns the number of leading ones in the binary representation of self.

§Examples

Basic usage:

let n = -1i128;

assert_eq!(n.leading_ones(), 128);

1.46.0 (const: 1.46.0) · source

pub const fn trailing_ones(self) -> u32

Returns the number of trailing ones in the binary representation of self.

§Examples

Basic usage:

let n = 3i128;

assert_eq!(n.trailing_ones(), 2);

1.0.0 (const: 1.32.0) · source

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

§Examples

Basic usage:

let n = 0x13f40000000000000000000000004f76i128;
let m = 0x4f7613f4;

assert_eq!(n.rotate_left(16), m);

1.0.0 (const: 1.32.0) · source

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

§Examples

Basic usage:

let n = 0x4f7613f4i128;
let m = 0x13f40000000000000000000000004f76;

assert_eq!(n.rotate_right(16), m);

1.0.0 (const: 1.32.0) · source

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

§Examples

Basic usage:

let n = 0x12345678901234567890123456789012i128;

let m = n.swap_bytes();

assert_eq!(m, 0x12907856341290785634129078563412);

1.37.0 (const: 1.37.0) · source

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

§Examples

Basic usage:

let n = 0x12345678901234567890123456789012i128;
let m = n.reverse_bits();

assert_eq!(m, 0x48091e6a2c48091e6a2c48091e6a2c48);
assert_eq!(0, 0i128.reverse_bits());

1.0.0 (const: 1.32.0) · source

pub const fn from_be(x: Self) -> Self

Converts an integer from big endian to the target’s endianness.

On big endian this is a no-op. On little endian the bytes are swapped.

§Examples

Basic usage:

let n = 0x1Ai128;

if cfg!(target_endian = "big") {
    assert_eq!(i128::from_be(n), n)
} else {
    assert_eq!(i128::from_be(n), n.swap_bytes())
}

1.0.0 (const: 1.32.0) · source

pub const fn from_le(x: Self) -> Self

Converts an integer from little endian to the target’s endianness.

On little endian this is a no-op. On big endian the bytes are swapped.

§Examples

Basic usage:

let n = 0x1Ai128;

if cfg!(target_endian = "little") {
    assert_eq!(i128::from_le(n), n)
} else {
    assert_eq!(i128::from_le(n), n.swap_bytes())
}

1.0.0 (const: 1.32.0) · source

pub const fn to_be(self) -> Self

Converts self to big endian from the target’s endianness.

On big endian this is a no-op. On little endian the bytes are swapped.

§Examples

Basic usage:

let n = 0x1Ai128;

if cfg!(target_endian = "big") {
    assert_eq!(n.to_be(), n)
} else {
    assert_eq!(n.to_be(), n.swap_bytes())
}

1.0.0 (const: 1.32.0) · source

pub const fn to_le(self) -> Self

Converts self to little endian from the target’s endianness.

On little endian this is a no-op. On big endian the bytes are swapped.

§Examples

Basic usage:

let n = 0x1Ai128;

if cfg!(target_endian = "little") {
    assert_eq!(n.to_le(), n)
} else {
    assert_eq!(n.to_le(), n.swap_bytes())
}

1.0.0 (const: 1.47.0) · source

pub const fn checked_add(self, rhs: Self) -> Option<Self>

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

§Examples

Basic usage:

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

const: unstable · source

pub fn strict_add(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer addition. Computes self + rhs, panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!((i128::MAX - 2).strict_add(1), i128::MAX - 1);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = (i128::MAX - 2).strict_add(3);

const: unstable · source

pub unsafe fn unchecked_add(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (unchecked_math #85122)

Unchecked integer addition. Computes self + rhs, assuming overflow cannot occur.

§Safety

This results in undefined behavior when self + rhs > i128::MAX or self + rhs < i128::MIN, i.e. when checked_add would return None.

1.66.0 (const: 1.66.0) · source

pub const fn checked_add_unsigned(self, rhs: u128) -> Option<Self>

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

§Examples

Basic usage:

assert_eq!(1i128.checked_add_unsigned(2), Some(3));
assert_eq!((i128::MAX - 2).checked_add_unsigned(3), None);

const: unstable · source

pub fn strict_add_unsigned(self, rhs: u128) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict addition with an unsigned integer. Computes self + rhs, panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(1i128.strict_add_unsigned(2), 3);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = (i128::MAX - 2).strict_add_unsigned(3);

1.0.0 (const: 1.47.0) · source

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

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

§Examples

Basic usage:

assert_eq!((i128::MIN + 2).checked_sub(1), Some(i128::MIN + 1));
assert_eq!((i128::MIN + 2).checked_sub(3), None);

const: unstable · source

pub fn strict_sub(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer subtraction. Computes self - rhs, panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!((i128::MIN + 2).strict_sub(1), i128::MIN + 1);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = (i128::MIN + 2).strict_sub(3);

const: unstable · source

pub unsafe fn unchecked_sub(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (unchecked_math #85122)

Unchecked integer subtraction. Computes self - rhs, assuming overflow cannot occur.

§Safety

This results in undefined behavior when self - rhs > i128::MAX or self - rhs < i128::MIN, i.e. when checked_sub would return None.

1.66.0 (const: 1.66.0) · source

pub const fn checked_sub_unsigned(self, rhs: u128) -> Option<Self>

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

§Examples

Basic usage:

assert_eq!(1i128.checked_sub_unsigned(2), Some(-1));
assert_eq!((i128::MIN + 2).checked_sub_unsigned(3), None);

const: unstable · source

pub fn strict_sub_unsigned(self, rhs: u128) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict subtraction with an unsigned integer. Computes self - rhs, panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(1i128.strict_sub_unsigned(2), -1);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = (i128::MIN + 2).strict_sub_unsigned(3);

1.0.0 (const: 1.47.0) · source

pub const fn checked_mul(self, rhs: Self) -> Option<Self>

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

§Examples

Basic usage:

assert_eq!(i128::MAX.checked_mul(1), Some(i128::MAX));
assert_eq!(i128::MAX.checked_mul(2), None);

const: unstable · source

pub fn strict_mul(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer multiplication. Computes self * rhs, panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(i128::MAX.strict_mul(1), i128::MAX);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = i128::MAX.strict_mul(2);

const: unstable · source

pub unsafe fn unchecked_mul(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (unchecked_math #85122)

Unchecked integer multiplication. Computes self * rhs, assuming overflow cannot occur.

§Safety

This results in undefined behavior when self * rhs > i128::MAX or self * rhs < i128::MIN, i.e. when checked_mul would return None.

1.0.0 (const: 1.52.0) · source

pub const fn checked_div(self, rhs: Self) -> Option<Self>

Checked integer division. Computes self / rhs, returning None if rhs == 0 or the division results in overflow.

§Examples

Basic usage:

assert_eq!((i128::MIN + 1).checked_div(-1), Some(170141183460469231731687303715884105727));
assert_eq!(i128::MIN.checked_div(-1), None);
assert_eq!((1i128).checked_div(0), None);

const: unstable · source

pub fn strict_div(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer division. Computes self / rhs, panicking if overflow occurred.

§Panics

This function will panic if rhs is zero.

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

The only case where such an overflow can occur is when one divides MIN / -1 on a signed type (where MIN is the negative minimal value for the type); this is equivalent to -MIN, a positive value that is too large to represent in the type.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!((i128::MIN + 1).strict_div(-1), 170141183460469231731687303715884105727);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = i128::MIN.strict_div(-1);

The following panics because of division by zero:

#![feature(strict_overflow_ops)]
let _ = (1i128).strict_div(0);

1.38.0 (const: 1.52.0) · source

pub const fn checked_div_euclid(self, rhs: Self) -> Option<Self>

Checked Euclidean division. Computes self.div_euclid(rhs), returning None if rhs == 0 or the division results in overflow.

§Examples

Basic usage:

assert_eq!((i128::MIN + 1).checked_div_euclid(-1), Some(170141183460469231731687303715884105727));
assert_eq!(i128::MIN.checked_div_euclid(-1), None);
assert_eq!((1i128).checked_div_euclid(0), None);

const: unstable · source

pub fn strict_div_euclid(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict Euclidean division. Computes self.div_euclid(rhs), panicking if overflow occurred.

§Panics

This function will panic if rhs is zero.

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

The only case where such an overflow can occur is when one divides MIN / -1 on a signed type (where MIN is the negative minimal value for the type); this is equivalent to -MIN, a positive value that is too large to represent in the type.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!((i128::MIN + 1).strict_div_euclid(-1), 170141183460469231731687303715884105727);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = i128::MIN.strict_div_euclid(-1);

The following panics because of division by zero:

#![feature(strict_overflow_ops)]
let _ = (1i128).strict_div_euclid(0);

1.7.0 (const: 1.52.0) · source

pub const fn checked_rem(self, rhs: Self) -> Option<Self>

Checked integer remainder. Computes self % rhs, returning None if rhs == 0 or the division results in overflow.

§Examples

Basic usage:

assert_eq!(5i128.checked_rem(2), Some(1));
assert_eq!(5i128.checked_rem(0), None);
assert_eq!(i128::MIN.checked_rem(-1), None);

const: unstable · source

pub fn strict_rem(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict integer remainder. Computes self % rhs, panicking if the division results in overflow.

§Panics

This function will panic if rhs is zero.

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

The only case where such an overflow can occur is x % y for MIN / -1 on a signed type (where MIN is the negative minimal value), which is invalid due to implementation artifacts.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(5i128.strict_rem(2), 1);

The following panics because of division by zero:

#![feature(strict_overflow_ops)]
let _ = 5i128.strict_rem(0);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = i128::MIN.strict_rem(-1);

1.38.0 (const: 1.52.0) · source

pub const fn checked_rem_euclid(self, rhs: Self) -> Option<Self>

Checked Euclidean remainder. Computes self.rem_euclid(rhs), returning None if rhs == 0 or the division results in overflow.

§Examples

Basic usage:

assert_eq!(5i128.checked_rem_euclid(2), Some(1));
assert_eq!(5i128.checked_rem_euclid(0), None);
assert_eq!(i128::MIN.checked_rem_euclid(-1), None);

const: unstable · source

pub fn strict_rem_euclid(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict Euclidean remainder. Computes self.rem_euclid(rhs), panicking if the division results in overflow.

§Panics

This function will panic if rhs is zero.

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

The only case where such an overflow can occur is x % y for MIN / -1 on a signed type (where MIN is the negative minimal value), which is invalid due to implementation artifacts.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(5i128.strict_rem_euclid(2), 1);

The following panics because of division by zero:

#![feature(strict_overflow_ops)]
let _ = 5i128.strict_rem_euclid(0);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = i128::MIN.strict_rem_euclid(-1);

1.7.0 (const: 1.47.0) · source

pub const fn checked_neg(self) -> Option<Self>

Checked negation. Computes -self, returning None if self == MIN.

§Examples

Basic usage:

assert_eq!(5i128.checked_neg(), Some(-5));
assert_eq!(i128::MIN.checked_neg(), None);

const: unstable · source

pub unsafe fn unchecked_neg(self) -> Self

🔬This is a nightly-only experimental API. (unchecked_neg #85122)

Unchecked negation. Computes -self, assuming overflow cannot occur.

§Safety

This results in undefined behavior when self == i128::MIN, i.e. when checked_neg would return None.

const: unstable · source

pub fn strict_neg(self) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict negation. Computes -self, panicking if self == MIN.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(5i128.strict_neg(), -5);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = i128::MIN.strict_neg();

1.7.0 (const: 1.47.0) · source

pub const fn checked_shl(self, rhs: u32) -> Option<Self>

Checked shift left. Computes self << rhs, returning None if rhs is larger than or equal to the number of bits in self.

§Examples

Basic usage:

assert_eq!(0x1i128.checked_shl(4), Some(0x10));
assert_eq!(0x1i128.checked_shl(129), None);

const: unstable · source

pub fn strict_shl(self, rhs: u32) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict shift left. Computes self << rhs, panicking if rhs is larger than or equal to the number of bits in self.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(0x1i128.strict_shl(4), 0x10);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = 0x1i128.strict_shl(129);

const: unstable · source

pub unsafe fn unchecked_shl(self, rhs: u32) -> Self

🔬This is a nightly-only experimental API. (unchecked_shifts #85122)

Unchecked shift left. Computes self << rhs, assuming that rhs is less than the number of bits in self.

§Safety

This results in undefined behavior if rhs is larger than or equal to the number of bits in self, i.e. when checked_shl would return None.

1.7.0 (const: 1.47.0) · source

pub const fn checked_shr(self, rhs: u32) -> Option<Self>

Checked shift right. Computes self >> rhs, returning None if rhs is larger than or equal to the number of bits in self.

§Examples

Basic usage:

assert_eq!(0x10i128.checked_shr(4), Some(0x1));
assert_eq!(0x10i128.checked_shr(128), None);

const: unstable · source

pub fn strict_shr(self, rhs: u32) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict shift right. Computes self >> rhs, panicking rhs is larger than or equal to the number of bits in self.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(0x10i128.strict_shr(4), 0x1);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = 0x10i128.strict_shr(128);

const: unstable · source

pub unsafe fn unchecked_shr(self, rhs: u32) -> Self

🔬This is a nightly-only experimental API. (unchecked_shifts #85122)

Unchecked shift right. Computes self >> rhs, assuming that rhs is less than the number of bits in self.

§Safety

This results in undefined behavior if rhs is larger than or equal to the number of bits in self, i.e. when checked_shr would return None.

1.13.0 (const: 1.47.0) · source

pub const fn checked_abs(self) -> Option<Self>

Checked absolute value. Computes self.abs(), returning None if self == MIN.

§Examples

Basic usage:

assert_eq!((-5i128).checked_abs(), Some(5));
assert_eq!(i128::MIN.checked_abs(), None);

const: unstable · source

pub fn strict_abs(self) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict absolute value. Computes self.abs(), panicking if self == MIN.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!((-5i128).strict_abs(), 5);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = i128::MIN.strict_abs();

1.34.0 (const: 1.50.0) · source

pub const fn checked_pow(self, exp: u32) -> Option<Self>

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

§Examples

Basic usage:

assert_eq!(8i128.checked_pow(2), Some(64));
assert_eq!(i128::MAX.checked_pow(2), None);

const: unstable · source

pub fn strict_pow(self, exp: u32) -> Self

🔬This is a nightly-only experimental API. (strict_overflow_ops #118260)

Strict exponentiation. Computes self.pow(exp), panicking if overflow occurred.

§Panics

§Overflow behavior

This function will always panic on overflow, regardless of whether overflow checks are enabled.

§Examples

Basic usage:

#![feature(strict_overflow_ops)]
assert_eq!(8i128.strict_pow(2), 64);

The following panics because of overflow:

#![feature(strict_overflow_ops)]
let _ = i128::MAX.strict_pow(2);

const: unstable · source

pub fn checked_isqrt(self) -> Option<Self>

🔬This is a nightly-only experimental API. (isqrt #116226)

Returns the square root of the number, rounded down.

Returns None if self is negative.

§Examples

Basic usage:

#![feature(isqrt)]
assert_eq!(10i128.checked_isqrt(), Some(3));

1.0.0 (const: 1.47.0) · source

pub const 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!(100i128.saturating_add(1), 101);
assert_eq!(i128::MAX.saturating_add(100), i128::MAX);
assert_eq!(i128::MIN.saturating_add(-1), i128::MIN);

1.66.0 (const: 1.66.0) · source

pub const fn saturating_add_unsigned(self, rhs: u128) -> Self

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

§Examples

Basic usage:

assert_eq!(1i128.saturating_add_unsigned(2), 3);
assert_eq!(i128::MAX.saturating_add_unsigned(100), i128::MAX);

1.0.0 (const: 1.47.0) · source

pub const fn saturating_sub(self, rhs: Self) -> Self

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

§Examples

Basic usage:

assert_eq!(100i128.saturating_sub(127), -27);
assert_eq!(i128::MIN.saturating_sub(100), i128::MIN);
assert_eq!(i128::MAX.saturating_sub(-1), i128::MAX);

1.66.0 (const: 1.66.0) · source

pub const fn saturating_sub_unsigned(self, rhs: u128) -> Self

Saturating subtraction with an unsigned integer. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

§Examples

Basic usage:

assert_eq!(100i128.saturating_sub_unsigned(127), -27);
assert_eq!(i128::MIN.saturating_sub_unsigned(100), i128::MIN);

1.45.0 (const: 1.47.0) · source

pub const fn saturating_neg(self) -> Self

Saturating integer negation. Computes -self, returning MAX if self == MIN instead of overflowing.

§Examples

Basic usage:

assert_eq!(100i128.saturating_neg(), -100);
assert_eq!((-100i128).saturating_neg(), 100);
assert_eq!(i128::MIN.saturating_neg(), i128::MAX);
assert_eq!(i128::MAX.saturating_neg(), i128::MIN + 1);

1.45.0 (const: 1.47.0) · source

pub const fn saturating_abs(self) -> Self

Saturating absolute value. Computes self.abs(), returning MAX if self == MIN instead of overflowing.

§Examples

Basic usage:

assert_eq!(100i128.saturating_abs(), 100);
assert_eq!((-100i128).saturating_abs(), 100);
assert_eq!(i128::MIN.saturating_abs(), i128::MAX);
assert_eq!((i128::MIN + 1).saturating_abs(), i128::MAX);

1.7.0 (const: 1.47.0) · source

pub const 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!(10i128.saturating_mul(12), 120);
assert_eq!(i128::MAX.saturating_mul(10), i128::MAX);
assert_eq!(i128::MIN.saturating_mul(10), i128::MIN);

1.58.0 (const: 1.58.0) · source

pub const fn saturating_div(self, rhs: Self) -> Self

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(5i128.saturating_div(2), 2);
assert_eq!(i128::MAX.saturating_div(-1), i128::MIN + 1);
assert_eq!(i128::MIN.saturating_div(-1), i128::MAX);

1.34.0 (const: 1.50.0) · source

pub const fn saturating_pow(self, exp: u32) -> Self

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

§Examples

Basic usage:

assert_eq!((-4i128).saturating_pow(3), -64);
assert_eq!(i128::MIN.saturating_pow(2), i128::MAX);
assert_eq!(i128::MIN.saturating_pow(3), i128::MIN);

1.0.0 (const: 1.32.0) · source

pub const fn wrapping_add(self, rhs: Self) -> Self

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(100i128.wrapping_add(27), 127);
assert_eq!(i128::MAX.wrapping_add(2), i128::MIN + 1);

1.66.0 (const: 1.66.0) · source

pub const fn wrapping_add_unsigned(self, rhs: u128) -> Self

Wrapping (modular) addition with an unsigned integer. Computes self + rhs, wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(100i128.wrapping_add_unsigned(27), 127);
assert_eq!(i128::MAX.wrapping_add_unsigned(2), i128::MIN + 1);

1.0.0 (const: 1.32.0) · source

pub const fn wrapping_sub(self, rhs: Self) -> Self

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(0i128.wrapping_sub(127), -127);
assert_eq!((-2i128).wrapping_sub(i128::MAX), i128::MAX);

1.66.0 (const: 1.66.0) · source

pub const fn wrapping_sub_unsigned(self, rhs: u128) -> Self

Wrapping (modular) subtraction with an unsigned integer. Computes self - rhs, wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(0i128.wrapping_sub_unsigned(127), -127);
assert_eq!((-2i128).wrapping_sub_unsigned(u128::MAX), -1);

1.0.0 (const: 1.32.0) · source

pub const fn wrapping_mul(self, rhs: Self) -> Self

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(10i128.wrapping_mul(12), 120);
assert_eq!(11i8.wrapping_mul(12), -124);

1.2.0 (const: 1.52.0) · source

pub const fn wrapping_div(self, rhs: Self) -> Self

Wrapping (modular) division. Computes self / rhs, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one divides MIN / -1 on a signed type (where MIN is the negative minimal value for the type); this is equivalent to -MIN, a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(100i128.wrapping_div(10), 10);
assert_eq!((-128i8).wrapping_div(-1), -128);

1.38.0 (const: 1.52.0) · source

pub const fn wrapping_div_euclid(self, rhs: Self) -> Self

Wrapping Euclidean division. Computes self.div_euclid(rhs), wrapping around at the boundary of the type.

Wrapping will only occur in MIN / -1 on a signed type (where MIN is the negative minimal value for the type). This is equivalent to -MIN, a positive value that is too large to represent in the type. In this case, this method returns MIN itself.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(100i128.wrapping_div_euclid(10), 10);
assert_eq!((-128i8).wrapping_div_euclid(-1), -128);

1.2.0 (const: 1.52.0) · source

pub const fn wrapping_rem(self, rhs: Self) -> Self

Wrapping (modular) remainder. Computes self % rhs, wrapping around at the boundary of the type.

Such wrap-around never actually occurs mathematically; implementation artifacts make x % y invalid for MIN / -1 on a signed type (where MIN is the negative minimal value). In such a case, this function returns 0.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(100i128.wrapping_rem(10), 0);
assert_eq!((-128i8).wrapping_rem(-1), 0);

1.38.0 (const: 1.52.0) · source

pub const fn wrapping_rem_euclid(self, rhs: Self) -> Self

Wrapping Euclidean remainder. Computes self.rem_euclid(rhs), wrapping around at the boundary of the type.

Wrapping will only occur in MIN % -1 on a signed type (where MIN is the negative minimal value for the type). In this case, this method returns 0.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(100i128.wrapping_rem_euclid(10), 0);
assert_eq!((-128i8).wrapping_rem_euclid(-1), 0);

1.2.0 (const: 1.32.0) · source

pub const fn wrapping_neg(self) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one negates MIN on a signed type (where MIN is the negative minimal value for the type); this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

§Examples

Basic usage:

assert_eq!(100i128.wrapping_neg(), -100);
assert_eq!(i128::MIN.wrapping_neg(), i128::MIN);

1.2.0 (const: 1.32.0) · source

pub const fn wrapping_shl(self, rhs: u32) -> Self

Panic-free bitwise shift-left; yields self << mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-left; the RHS of a wrapping shift-left is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. The primitive integer types all implement a rotate_left function, which may be what you want instead.

§Examples

Basic usage:

assert_eq!((-1i128).wrapping_shl(7), -128);
assert_eq!((-1i128).wrapping_shl(128), -1);

1.2.0 (const: 1.32.0) · source

pub const fn wrapping_shr(self, rhs: u32) -> Self

Panic-free bitwise shift-right; yields self >> mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-right; the RHS of a wrapping shift-right is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. The primitive integer types all implement a rotate_right function, which may be what you want instead.

§Examples

Basic usage:

assert_eq!((-128i128).wrapping_shr(7), -1);
assert_eq!((-128i16).wrapping_shr(64), -128);

1.13.0 (const: 1.32.0) · source

pub const fn wrapping_abs(self) -> Self

Wrapping (modular) absolute value. Computes self.abs(), wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one takes the absolute value of the negative minimal value for the type; this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

§Examples

Basic usage:

assert_eq!(100i128.wrapping_abs(), 100);
assert_eq!((-100i128).wrapping_abs(), 100);
assert_eq!(i128::MIN.wrapping_abs(), i128::MIN);
assert_eq!((-128i8).wrapping_abs() as u8, 128);

1.51.0 (const: 1.51.0) · source

pub const fn unsigned_abs(self) -> u128

Computes the absolute value of self without any wrapping or panicking.

§Examples

Basic usage:

assert_eq!(100i128.unsigned_abs(), 100u128);
assert_eq!((-100i128).unsigned_abs(), 100u128);
assert_eq!((-128i8).unsigned_abs(), 128u8);

1.34.0 (const: 1.50.0) · source

pub const fn wrapping_pow(self, exp: u32) -> Self

Wrapping (modular) exponentiation. Computes self.pow(exp), wrapping around at the boundary of the type.

§Examples

Basic usage:

assert_eq!(3i128.wrapping_pow(4), 81);
assert_eq!(3i8.wrapping_pow(5), -13);
assert_eq!(3i8.wrapping_pow(6), -39);

1.7.0 (const: 1.32.0) · source

pub const fn overflowing_add(self, rhs: Self) -> (Self, bool)

Calculates self + rhs

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

§Examples

Basic usage:

assert_eq!(5i128.overflowing_add(2), (7, false));
assert_eq!(i128::MAX.overflowing_add(1), (i128::MIN, true));

const: unstable · source

pub fn carrying_add(self, rhs: Self, carry: bool) -> (Self, bool)

🔬This is a nightly-only experimental API. (bigint_helper_methods #85532)

Calculates self + rhs + carry and checks for overflow.

Performs “ternary addition” of two integer operands and a carry-in bit, and returns a tuple of the sum along with a boolean indicating whether an arithmetic overflow would occur. On overflow, the wrapped value is returned.

This allows chaining together multiple additions to create a wider addition, and can be useful for bignum addition. This method should only be used for the most significant word; for the less significant words the unsigned method u128::carrying_add should be used.

The output boolean returned by this method is not a carry flag, and should not be added to a more significant word.

If the input carry is false, this method is equivalent to overflowing_add.

§Examples

#![feature(bigint_helper_methods)]
// Only the most significant word is signed.
//
//   10  MAX    (a = 10 × 2^128 + 2^128 - 1)
// + -5    9    (b = -5 × 2^128 + 9)
// ---------
//    6    8    (sum = 6 × 2^128 + 8)

let (a1, a0): (i128, u128) = (10, u128::MAX);
let (b1, b0): (i128, u128) = (-5, 9);
let carry0 = false;

// u128::carrying_add for the less significant words
let (sum0, carry1) = a0.carrying_add(b0, carry0);
assert_eq!(carry1, true);

// i128::carrying_add for the most significant word
let (sum1, overflow) = a1.carrying_add(b1, carry1);
assert_eq!(overflow, false);

assert_eq!((sum1, sum0), (6, 8));

1.66.0 (const: 1.66.0) · source

pub const fn overflowing_add_unsigned(self, rhs: u128) -> (Self, bool)

Calculates self + rhs with an unsigned rhs

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

§Examples

Basic usage:

assert_eq!(1i128.overflowing_add_unsigned(2), (3, false));
assert_eq!((i128::MIN).overflowing_add_unsigned(u128::MAX), (i128::MAX, false));
assert_eq!((i128::MAX - 2).overflowing_add_unsigned(3), (i128::MIN, true));

1.7.0 (const: 1.32.0) · source

pub const fn overflowing_sub(self, rhs: Self) -> (Self, bool)

Calculates self - rhs

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

§Examples

Basic usage:

assert_eq!(5i128.overflowing_sub(2), (3, false));
assert_eq!(i128::MIN.overflowing_sub(1), (i128::MAX, true));

const: unstable · source

pub fn borrowing_sub(self, rhs: Self, borrow: bool) -> (Self, bool)

🔬This is a nightly-only experimental API. (bigint_helper_methods #85532)

Calculates self − rhs − borrow and checks for overflow.

Performs “ternary subtraction” by subtracting both an integer operand and a borrow-in bit from self, and returns a tuple of the difference along with a boolean indicating whether an arithmetic overflow would occur. On overflow, the wrapped value is returned.

This allows chaining together multiple subtractions to create a wider subtraction, and can be useful for bignum subtraction. This method should only be used for the most significant word; for the less significant words the unsigned method u128::borrowing_sub should be used.

The output boolean returned by this method is not a borrow flag, and should not be subtracted from a more significant word.

If the input borrow is false, this method is equivalent to overflowing_sub.

§Examples

#![feature(bigint_helper_methods)]
// Only the most significant word is signed.
//
//    6    8    (a = 6 × 2^128 + 8)
// - -5    9    (b = -5 × 2^128 + 9)
// ---------
//   10  MAX    (diff = 10 × 2^128 + 2^128 - 1)

let (a1, a0): (i128, u128) = (6, 8);
let (b1, b0): (i128, u128) = (-5, 9);
let borrow0 = false;

// u128::borrowing_sub for the less significant words
let (diff0, borrow1) = a0.borrowing_sub(b0, borrow0);
assert_eq!(borrow1, true);

// i128::borrowing_sub for the most significant word
let (diff1, overflow) = a1.borrowing_sub(b1, borrow1);
assert_eq!(overflow, false);

assert_eq!((diff1, diff0), (10, u128::MAX));

1.66.0 (const: 1.66.0) · source

pub const fn overflowing_sub_unsigned(self, rhs: u128) -> (Self, bool)

Calculates self - rhs with an unsigned rhs

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

§Examples

Basic usage:

assert_eq!(1i128.overflowing_sub_unsigned(2), (-1, false));
assert_eq!((i128::MAX).overflowing_sub_unsigned(u128::MAX), (i128::MIN, false));
assert_eq!((i128::MIN + 2).overflowing_sub_unsigned(3), (i128::MAX, true));

1.7.0 (const: 1.32.0) · source

pub const fn overflowing_mul(self, rhs: Self) -> (Self, bool)

Calculates the multiplication of self and rhs.

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

§Examples

Basic usage:

assert_eq!(5i128.overflowing_mul(2), (10, false));
assert_eq!(1_000_000_000i32.overflowing_mul(10), (1410065408, true));

1.7.0 (const: 1.52.0) · source

pub const fn overflowing_div(self, rhs: Self) -> (Self, bool)

Calculates the divisor when self is divided by rhs.

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(5i128.overflowing_div(2), (2, false));
assert_eq!(i128::MIN.overflowing_div(-1), (i128::MIN, true));

1.38.0 (const: 1.52.0) · source

pub const fn overflowing_div_euclid(self, rhs: Self) -> (Self, bool)

Calculates the quotient of Euclidean division self.div_euclid(rhs).

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(5i128.overflowing_div_euclid(2), (2, false));
assert_eq!(i128::MIN.overflowing_div_euclid(-1), (i128::MIN, true));

1.7.0 (const: 1.52.0) · source

pub const fn overflowing_rem(self, rhs: Self) -> (Self, bool)

Calculates the remainder when self is divided by rhs.

Returns a tuple of the remainder after dividing along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then 0 is returned.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(5i128.overflowing_rem(2), (1, false));
assert_eq!(i128::MIN.overflowing_rem(-1), (0, true));

1.38.0 (const: 1.52.0) · source

pub const fn overflowing_rem_euclid(self, rhs: Self) -> (Self, bool)

Overflowing Euclidean remainder. Calculates self.rem_euclid(rhs).

Returns a tuple of the remainder after dividing along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then 0 is returned.

§Panics

This function will panic if rhs is 0.

§Examples

Basic usage:

assert_eq!(5i128.overflowing_rem_euclid(2), (1, false));
assert_eq!(i128::MIN.overflowing_rem_euclid(-1), (0, true));

1.7.0 (const: 1.32.0) · source

pub const fn overflowing_neg(self) -> (Self, bool)

Negates self, overflowing if this is equal to the minimum value.

Returns a tuple of the negated version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g., i32::MIN for values of type i32), then the minimum value will be returned again and true will be returned for an overflow happening.

§Examples

Basic usage:

assert_eq!(2i128.overflowing_neg(), (-2, false));
assert_eq!(i128::MIN.overflowing_neg(), (i128::MIN, true));

1.7.0 (const: 1.32.0) · source

pub const fn overflowing_shl(self, rhs: u32) -> (Self, bool)

Shifts self left by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

§Examples

Basic usage:

assert_eq!(0x1i128.overflowing_shl(4), (0x10, false));
assert_eq!(0x1i32.overflowing_shl(36), (0x10, true));

1.7.0 (const: 1.32.0) · source

pub const fn overflowing_shr(self, rhs: u32) -> (Self, bool)

Shifts self right by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

§Examples

Basic usage:

assert_eq!(0x10i128.overflowing_shr(4), (0x1, false));
assert_eq!(0x10i32.overflowing_shr(36), (0x1, true));

1.13.0 (const: 1.32.0) · source

pub const fn overflowing_abs(self) -> (Self, bool)

Computes the absolute value of self.

Returns a tuple of the absolute version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g., i128::MIN for values of type i128), then the minimum value will be returned again and true will be returned for an overflow happening.

§Examples

Basic usage:

assert_eq!(10i128.overflowing_abs(), (10, false));
assert_eq!((-10i128).overflowing_abs(), (10, false));
assert_eq!((i128::MIN).overflowing_abs(), (i128::MIN, true));

1.34.0 (const: 1.50.0) · source

pub const fn overflowing_pow(self, exp: u32) -> (Self, bool)

Raises self to the power of exp, using exponentiation by squaring.

Returns a tuple of the exponentiation along with a bool indicating whether an overflow happened.

§Examples

Basic usage:

assert_eq!(3i128.overflowing_pow(4), (81, false));
assert_eq!(3i8.overflowing_pow(5), (-13, true));

1.0.0 (const: 1.50.0) · source

pub const fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring.

§Examples

Basic usage:

let x: i128 = 2; // or any other integer type

assert_eq!(x.pow(5), 32);

const: unstable · source

pub fn isqrt(self) -> Self

🔬This is a nightly-only experimental API. (isqrt #116226)

Returns the square root of the number, rounded down.

§Panics

This function will panic if self is negative.

§Examples

Basic usage:

#![feature(isqrt)]
assert_eq!(10i128.isqrt(), 3);

1.38.0 (const: 1.52.0) · source

pub const fn div_euclid(self, rhs: Self) -> Self

Calculates the quotient of Euclidean division of self by rhs.

This computes the integer q such that self = q * rhs + r, with r = self.rem_euclid(rhs) and 0 <= r < abs(rhs).

In other words, the result is self / rhs rounded to the integer q such that self >= q * rhs. If self > 0, this is equal to round towards zero (the default in Rust); if self < 0, this is equal to round towards +/- infinity.

§Panics

This function will panic if rhs is 0 or if self is -1 and rhs is Self::MIN. This behavior is not affected by the overflow-checks flag.

§Examples

Basic usage:

let a: i128 = 7; // or any other integer type
let b = 4;

assert_eq!(a.div_euclid(b), 1); // 7 >= 4 * 1
assert_eq!(a.div_euclid(-b), -1); // 7 >= -4 * -1
assert_eq!((-a).div_euclid(b), -2); // -7 >= 4 * -2
assert_eq!((-a).div_euclid(-b), 2); // -7 >= -4 * 2

1.38.0 (const: 1.52.0) · source

pub const fn rem_euclid(self, rhs: Self) -> Self

Calculates the least nonnegative remainder of self (mod rhs).

This is done as if by the Euclidean division algorithm – given r = self.rem_euclid(rhs), self = rhs * self.div_euclid(rhs) + r, and 0 <= r < abs(rhs).

§Panics

This function will panic if rhs is 0 or if self is -1 and rhs is Self::MIN. This behavior is not affected by the overflow-checks flag.

§Examples

Basic usage:

let a: i128 = 7; // or any other integer type
let b = 4;

assert_eq!(a.rem_euclid(b), 3);
assert_eq!((-a).rem_euclid(b), 1);
assert_eq!(a.rem_euclid(-b), 3);
assert_eq!((-a).rem_euclid(-b), 1);

pub const fn div_floor(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (int_roundings #88581)

Calculates the quotient of self and rhs, rounding the result towards negative infinity.

§Panics

This function will panic if rhs is 0 or if self is -1 and rhs is Self::MIN. This behavior is not affected by the overflow-checks flag.

§Examples

Basic usage:

#![feature(int_roundings)]
let a: i128 = 8;
let b = 3;

assert_eq!(a.div_floor(b), 2);
assert_eq!(a.div_floor(-b), -3);
assert_eq!((-a).div_floor(b), -3);
assert_eq!((-a).div_floor(-b), 2);

pub const fn div_ceil(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (int_roundings #88581)

Calculates the quotient of self and rhs, rounding the result towards positive infinity.

§Panics

This function will panic if rhs is 0 or if self is -1 and rhs is Self::MIN. This behavior is not affected by the overflow-checks flag.

§Examples

Basic usage:

#![feature(int_roundings)]
let a: i128 = 8;
let b = 3;

assert_eq!(a.div_ceil(b), 3);
assert_eq!(a.div_ceil(-b), -2);
assert_eq!((-a).div_ceil(b), -2);
assert_eq!((-a).div_ceil(-b), 3);

pub const fn next_multiple_of(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (int_roundings #88581)

If rhs is positive, calculates the smallest value greater than or equal to self that is a multiple of rhs. If rhs is negative, calculates the largest value less than or equal to self that is a multiple of rhs.

§Panics

This function will panic if rhs is zero.

§Overflow behavior

On overflow, this function will panic if overflow checks are enabled (default in debug mode) and wrap if overflow checks are disabled (default in release mode).

§Examples

Basic usage:

#![feature(int_roundings)]
assert_eq!(16_i128.next_multiple_of(8), 16);
assert_eq!(23_i128.next_multiple_of(8), 24);
assert_eq!(16_i128.next_multiple_of(-8), 16);
assert_eq!(23_i128.next_multiple_of(-8), 16);
assert_eq!((-16_i128).next_multiple_of(8), -16);
assert_eq!((-23_i128).next_multiple_of(8), -16);
assert_eq!((-16_i128).next_multiple_of(-8), -16);
assert_eq!((-23_i128).next_multiple_of(-8), -24);

pub const fn checked_next_multiple_of(self, rhs: Self) -> Option<Self>

🔬This is a nightly-only experimental API. (int_roundings #88581)

If rhs is positive, calculates the smallest value greater than or equal to self that is a multiple of rhs. If rhs is negative, calculates the largest value less than or equal to self that is a multiple of rhs. Returns None if rhs is zero or the operation would result in overflow.

§Examples

Basic usage:

#![feature(int_roundings)]
assert_eq!(16_i128.checked_next_multiple_of(8), Some(16));
assert_eq!(23_i128.checked_next_multiple_of(8), Some(24));
assert_eq!(16_i128.checked_next_multiple_of(-8), Some(16));
assert_eq!(23_i128.checked_next_multiple_of(-8), Some(16));
assert_eq!((-16_i128).checked_next_multiple_of(8), Some(-16));
assert_eq!((-23_i128).checked_next_multiple_of(8), Some(-16));
assert_eq!((-16_i128).checked_next_multiple_of(-8), Some(-16));
assert_eq!((-23_i128).checked_next_multiple_of(-8), Some(-24));
assert_eq!(1_i128.checked_next_multiple_of(0), None);
assert_eq!(i128::MAX.checked_next_multiple_of(2), None);

const: unstable · source

pub fn midpoint(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (num_midpoint #110840)

Calculates the middle point of self and rhs.

midpoint(a, b) is (a + b) >> 1 as if it were performed in a sufficiently-large signed integral type. This implies that the result is always rounded towards negative infinity and that no overflow will ever occur.

§Examples

#![feature(num_midpoint)]
assert_eq!(0i128.midpoint(4), 2);
assert_eq!(0i128.midpoint(-1), -1);
assert_eq!((-1i128).midpoint(0), -1);

1.67.0 (const: 1.67.0) · source

pub const fn ilog(self, base: Self) -> u32

Returns the logarithm of the number with respect to an arbitrary base, rounded down.

This method might not be optimized owing to implementation details; ilog2 can produce results more efficiently for base 2, and ilog10 can produce results more efficiently for base 10.

§Panics

This function will panic if self is less than or equal to zero, or if base is less than 2.

§Examples

assert_eq!(5i128.ilog(5), 1);

1.67.0 (const: 1.67.0) · source

pub const fn ilog2(self) -> u32

Returns the base 2 logarithm of the number, rounded down.

§Panics

This function will panic if self is less than or equal to zero.

§Examples

assert_eq!(2i128.ilog2(), 1);

1.67.0 (const: 1.67.0) · source

pub const fn ilog10(self) -> u32

Returns the base 10 logarithm of the number, rounded down.

§Panics

This function will panic if self is less than or equal to zero.

§Example

assert_eq!(10i128.ilog10(), 1);

1.67.0 (const: 1.67.0) · source

pub const fn checked_ilog(self, base: Self) -> Option<u32>

Returns the logarithm of the number with respect to an arbitrary base, rounded down.

Returns None if the number is negative or zero, or if the base is not at least 2.

This method might not be optimized owing to implementation details; checked_ilog2 can produce results more efficiently for base 2, and checked_ilog10 can produce results more efficiently for base 10.

§Examples

assert_eq!(5i128.checked_ilog(5), Some(1));

1.67.0 (const: 1.67.0) · source

pub const fn checked_ilog2(self) -> Option<u32>

Returns the base 2 logarithm of the number, rounded down.

Returns None if the number is negative or zero.

§Examples

assert_eq!(2i128.checked_ilog2(), Some(1));

1.67.0 (const: 1.67.0) · source

pub const fn checked_ilog10(self) -> Option<u32>

Returns the base 10 logarithm of the number, rounded down.

Returns None if the number is negative or zero.

§Example

assert_eq!(10i128.checked_ilog10(), Some(1));

1.0.0 (const: 1.32.0) · source

pub const fn abs(self) -> Self

Computes the absolute value of self.

§Overflow behavior

The absolute value of i128::MIN cannot be represented as an i128, and attempting to calculate it will cause an overflow. This means that code in debug mode will trigger a panic on this case and optimized code will return i128::MIN without a panic.

§Examples

Basic usage:

assert_eq!(10i128.abs(), 10);
assert_eq!((-10i128).abs(), 10);

1.60.0 (const: 1.60.0) · source

pub const fn abs_diff(self, other: Self) -> u128

Computes the absolute difference between self and other.

This function always returns the correct answer without overflow or panics by returning an unsigned integer.

§Examples

Basic usage:

assert_eq!(100i128.abs_diff(80), 20u128);
assert_eq!(100i128.abs_diff(110), 10u128);
assert_eq!((-100i128).abs_diff(80), 180u128);
assert_eq!((-100i128).abs_diff(-120), 20u128);
assert_eq!(i128::MIN.abs_diff(i128::MAX), u128::MAX);

1.0.0 (const: 1.47.0) · source

pub const fn signum(self) -> Self

Returns a number representing sign of self.

0 if the number is zero
1 if the number is positive
-1 if the number is negative

§Examples

Basic usage:

assert_eq!(10i128.signum(), 1);
assert_eq!(0i128.signum(), 0);
assert_eq!((-10i128).signum(), -1);

1.0.0 (const: 1.32.0) · source

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!(10i128.is_positive());
assert!(!(-10i128).is_positive());

1.0.0 (const: 1.32.0) · source

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!((-10i128).is_negative());
assert!(!10i128.is_negative());

1.32.0 (const: 1.44.0) · source

pub const fn to_be_bytes(self) -> [u8; 16]

Return the memory representation of this integer as a byte array in big-endian (network) byte order.

§Examples

let bytes = 0x12345678901234567890123456789012i128.to_be_bytes();
assert_eq!(bytes, [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]);

1.32.0 (const: 1.44.0) · source

pub const fn to_le_bytes(self) -> [u8; 16]

Return the memory representation of this integer as a byte array in little-endian byte order.

§Examples

let bytes = 0x12345678901234567890123456789012i128.to_le_bytes();
assert_eq!(bytes, [0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);

1.32.0 (const: 1.44.0) · source

pub const fn to_ne_bytes(self) -> [u8; 16]

Return the memory representation of this integer as a byte array in native byte order.

As the target platform’s native endianness is used, portable code should use to_be_bytes or to_le_bytes, as appropriate, instead.

§Examples

let bytes = 0x12345678901234567890123456789012i128.to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]
    } else {
        [0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    }
);

1.32.0 (const: 1.44.0) · source

pub const fn from_be_bytes(bytes: [u8; 16]) -> Self

Create an integer value from its representation as a byte array in big endian.

§Examples

let value = i128::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]);
assert_eq!(value, 0x12345678901234567890123456789012);

When starting from a slice rather than an array, fallible conversion APIs can be used:

fn read_be_i128(input: &mut &[u8]) -> i128 {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<i128>());
    *input = rest;
    i128::from_be_bytes(int_bytes.try_into().unwrap())
}

1.32.0 (const: 1.44.0) · source

pub const fn from_le_bytes(bytes: [u8; 16]) -> Self

Create an integer value from its representation as a byte array in little endian.

§Examples

let value = i128::from_le_bytes([0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);
assert_eq!(value, 0x12345678901234567890123456789012);

When starting from a slice rather than an array, fallible conversion APIs can be used:

fn read_le_i128(input: &mut &[u8]) -> i128 {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<i128>());
    *input = rest;
    i128::from_le_bytes(int_bytes.try_into().unwrap())
}

1.32.0 (const: 1.44.0) · source

pub const fn from_ne_bytes(bytes: [u8; 16]) -> Self

Create an integer value from its memory representation as a byte array in native endianness.

As the target platform’s native endianness is used, portable code likely wants to use from_be_bytes or from_le_bytes, as appropriate instead.

§Examples

let value = i128::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]
} else {
    [0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value, 0x12345678901234567890123456789012);

When starting from a slice rather than an array, fallible conversion APIs can be used:

fn read_ne_i128(input: &mut &[u8]) -> i128 {
    let (int_bytes, rest) = input.split_at(std::mem::size_of::<i128>());
    *input = rest;
    i128::from_ne_bytes(int_bytes.try_into().unwrap())
}

1.0.0 (const: 1.32.0) · source

pub const fn min_value() -> Self

👎Deprecating in a future version: replaced by the MIN associated constant on this type

New code should prefer to use i128::MIN instead.

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

1.0.0 (const: 1.32.0) · source

pub const fn max_value() -> Self

👎Deprecating in a future version: replaced by the MAX associated constant on this type

New code should prefer to use i128::MAX instead.

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

Returns a copy of the value. Read more

1.0.0 · source§

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

fn from(small: bool) -> Self

Converts a bool to i128 losslessly. The resulting value is 0 for false and 1 for true values.

§Examples

assert_eq!(i128::from(true), 1);
assert_eq!(i128::from(false), 0);

impl Hash for i128

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

fn hash_slice<H: Hasher>(data: &[i128], state: &mut H)

Feeds a slice of this type into the given Hasher. Read more

1.42.0 · source§

impl LowerExp for i128

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

Formats the value using the given formatter.

1.0.0 · source§

Formats the value using the given formatter.

1.0.0 · source§

impl Ord for i128

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

This method returns an Ordering between self and other. Read more

1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

1.0.0 (const: unstable) · source§

impl PartialEq for i128

const: unstable · source§

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

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

const: unstable · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

1.0.0 · source§

The resulting type after applying the % operator.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

§

type Error = >::Error

The type returned in the event of a conversion error.