Type Alias core::arch::x86::_MM_PERM_ENUM

pub type _MM_PERM_ENUM = i32;

🔬This is a nightly-only experimental API. (stdsimd #48556)

Available on x86 and (x86 or x86-64) only.

The MM_PERM_ENUM type used to specify shuffle operations in AVX-512 intrinsics.

Implementations

impl i32

pub const MIN: Self = -2_147_483_648i32

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

Examples

Basic usage:

assert_eq!(i32::MIN, -2147483648);

pub const MAX: Self = 2_147_483_647i32

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

Examples

Basic usage:

assert_eq!(i32::MAX, 2147483647);

pub const BITS: u32 = 32u32

The size of this integer type in bits.

Examples

assert_eq!(i32::BITS, 32);

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

pub const fn count_ones(self) -> u32

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

Examples

Basic usage:

let n = 0b100_0000i32;

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

pub const fn count_zeros(self) -> u32

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

Examples

Basic usage:

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

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 = -1i32;

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

pub const fn trailing_zeros(self) -> u32

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

Examples

Basic usage:

let n = -4i32;

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

pub const fn leading_ones(self) -> u32

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

Examples

Basic usage:

let n = -1i32;

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

pub const fn trailing_ones(self) -> u32

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

Examples

Basic usage:

let n = 3i32;

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

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 = 0x10000b3i32;
let m = 0xb301;

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

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 = 0xb301i32;
let m = 0x10000b3;

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

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

Examples

Basic usage:

let n = 0x12345678i32;

let m = n.swap_bytes();

assert_eq!(m, 0x78563412);

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 = 0x12345678i32;
let m = n.reverse_bits();

assert_eq!(m, 0x1e6a2c48);
assert_eq!(0, 0i32.reverse_bits());

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 = 0x1Ai32;

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

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 = 0x1Ai32;

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

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 = 0x1Ai32;

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

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 = 0x1Ai32;

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

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!((i32::MAX - 2).checked_add(1), Some(i32::MAX - 1));
assert_eq!((i32::MAX - 2).checked_add(3), None);

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 > i32::MAX or self + rhs < i32::MIN, i.e. when checked_add would return None.

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

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

Examples

Basic usage:

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

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!((i32::MIN + 2).checked_sub(1), Some(i32::MIN + 1));
assert_eq!((i32::MIN + 2).checked_sub(3), None);

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 > i32::MAX or self - rhs < i32::MIN, i.e. when checked_sub would return None.

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

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

Examples

Basic usage:

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

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!(i32::MAX.checked_mul(1), Some(i32::MAX));
assert_eq!(i32::MAX.checked_mul(2), None);

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 > i32::MAX or self * rhs < i32::MIN, i.e. when checked_mul would return None.

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!((i32::MIN + 1).checked_div(-1), Some(2147483647));
assert_eq!(i32::MIN.checked_div(-1), None);
assert_eq!((1i32).checked_div(0), None);

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!((i32::MIN + 1).checked_div_euclid(-1), Some(2147483647));
assert_eq!(i32::MIN.checked_div_euclid(-1), None);
assert_eq!((1i32).checked_div_euclid(0), None);

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!(5i32.checked_rem(2), Some(1));
assert_eq!(5i32.checked_rem(0), None);
assert_eq!(i32::MIN.checked_rem(-1), None);

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!(5i32.checked_rem_euclid(2), Some(1));
assert_eq!(5i32.checked_rem_euclid(0), None);
assert_eq!(i32::MIN.checked_rem_euclid(-1), None);

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

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

Examples

Basic usage:

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

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!(0x1i32.checked_shl(4), Some(0x10));
assert_eq!(0x1i32.checked_shl(129), None);

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

🔬This is a nightly-only experimental API. (unchecked_math #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.

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!(0x10i32.checked_shr(4), Some(0x1));
assert_eq!(0x10i32.checked_shr(128), None);

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

🔬This is a nightly-only experimental API. (unchecked_math #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.

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

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

Examples

Basic usage:

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

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!(8i32.checked_pow(2), Some(64));
assert_eq!(i32::MAX.checked_pow(2), None);

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!(10i32.checked_isqrt(), Some(3));

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

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

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

Examples

Basic usage:

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

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!(100i32.saturating_sub(127), -27);
assert_eq!(i32::MIN.saturating_sub(100), i32::MIN);
assert_eq!(i32::MAX.saturating_sub(-1), i32::MAX);

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

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

Examples

Basic usage:

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

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!(100i32.saturating_neg(), -100);
assert_eq!((-100i32).saturating_neg(), 100);
assert_eq!(i32::MIN.saturating_neg(), i32::MAX);
assert_eq!(i32::MAX.saturating_neg(), i32::MIN + 1);

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!(100i32.saturating_abs(), 100);
assert_eq!((-100i32).saturating_abs(), 100);
assert_eq!(i32::MIN.saturating_abs(), i32::MAX);
assert_eq!((i32::MIN + 1).saturating_abs(), i32::MAX);

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

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

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

Examples

Basic usage:

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

let _ = 1i32.saturating_div(0);

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!((-4i32).saturating_pow(3), -64);
assert_eq!(i32::MIN.saturating_pow(2), i32::MAX);
assert_eq!(i32::MIN.saturating_pow(3), i32::MIN);

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!(100i32.wrapping_add(27), 127);
assert_eq!(i32::MAX.wrapping_add(2), i32::MIN + 1);

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

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

Examples

Basic usage:

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

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!(0i32.wrapping_sub(127), -127);
assert_eq!((-2i32).wrapping_sub(i32::MAX), i32::MAX);

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

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

Examples

Basic usage:

assert_eq!(0i32.wrapping_sub_unsigned(127), -127);
assert_eq!((-2i32).wrapping_sub_unsigned(u32::MAX), -1);

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!(10i32.wrapping_mul(12), 120);
assert_eq!(11i8.wrapping_mul(12), -124);

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!(100i32.wrapping_div(10), 10);
assert_eq!((-128i8).wrapping_div(-1), -128);

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!(100i32.wrapping_div_euclid(10), 10);
assert_eq!((-128i8).wrapping_div_euclid(-1), -128);

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!(100i32.wrapping_rem(10), 0);
assert_eq!((-128i8).wrapping_rem(-1), 0);

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!(100i32.wrapping_rem_euclid(10), 0);
assert_eq!((-128i8).wrapping_rem_euclid(-1), 0);

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!(100i32.wrapping_neg(), -100);
assert_eq!(i32::MIN.wrapping_neg(), i32::MIN);

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!((-1i32).wrapping_shl(7), -128);
assert_eq!((-1i32).wrapping_shl(128), -1);

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!((-128i32).wrapping_shr(7), -1);
assert_eq!((-128i16).wrapping_shr(64), -128);

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!(100i32.wrapping_abs(), 100);
assert_eq!((-100i32).wrapping_abs(), 100);
assert_eq!(i32::MIN.wrapping_abs(), i32::MIN);
assert_eq!((-128i8).wrapping_abs() as u8, 128);

pub const fn unsigned_abs(self) -> u32

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

Examples

Basic usage:

assert_eq!(100i32.unsigned_abs(), 100u32);
assert_eq!((-100i32).unsigned_abs(), 100u32);
assert_eq!((-128i8).unsigned_abs(), 128u8);

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!(3i32.wrapping_pow(4), 81);
assert_eq!(3i8.wrapping_pow(5), -13);
assert_eq!(3i8.wrapping_pow(6), -39);

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!(5i32.overflowing_add(2), (7, false));
assert_eq!(i32::MAX.overflowing_add(1), (i32::MIN, true));

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 u32::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^32 + 2^32 - 1)
// + -5    9    (b = -5 × 2^32 + 9)
// ---------
//    6    8    (sum = 6 × 2^32 + 8)

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

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

// i32::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));

pub const fn overflowing_add_unsigned(self, rhs: u32) -> (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!(1i32.overflowing_add_unsigned(2), (3, false));
assert_eq!((i32::MIN).overflowing_add_unsigned(u32::MAX), (i32::MAX, false));
assert_eq!((i32::MAX - 2).overflowing_add_unsigned(3), (i32::MIN, true));

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!(5i32.overflowing_sub(2), (3, false));
assert_eq!(i32::MIN.overflowing_sub(1), (i32::MAX, true));

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 u32::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^32 + 8)
// - -5    9    (b = -5 × 2^32 + 9)
// ---------
//   10  MAX    (diff = 10 × 2^32 + 2^32 - 1)

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

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

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

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

pub const fn overflowing_sub_unsigned(self, rhs: u32) -> (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!(1i32.overflowing_sub_unsigned(2), (-1, false));
assert_eq!((i32::MAX).overflowing_sub_unsigned(u32::MAX), (i32::MIN, false));
assert_eq!((i32::MIN + 2).overflowing_sub_unsigned(3), (i32::MAX, true));

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!(5i32.overflowing_mul(2), (10, false));
assert_eq!(1_000_000_000i32.overflowing_mul(10), (1410065408, true));

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!(5i32.overflowing_div(2), (2, false));
assert_eq!(i32::MIN.overflowing_div(-1), (i32::MIN, true));

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!(5i32.overflowing_div_euclid(2), (2, false));
assert_eq!(i32::MIN.overflowing_div_euclid(-1), (i32::MIN, true));

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!(5i32.overflowing_rem(2), (1, false));
assert_eq!(i32::MIN.overflowing_rem(-1), (0, true));

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!(5i32.overflowing_rem_euclid(2), (1, false));
assert_eq!(i32::MIN.overflowing_rem_euclid(-1), (0, true));

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!(2i32.overflowing_neg(), (-2, false));
assert_eq!(i32::MIN.overflowing_neg(), (i32::MIN, true));

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!(0x1i32.overflowing_shl(4), (0x10, false));
assert_eq!(0x1i32.overflowing_shl(36), (0x10, true));

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!(0x10i32.overflowing_shr(4), (0x1, false));
assert_eq!(0x10i32.overflowing_shr(36), (0x1, true));

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., 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!(10i32.overflowing_abs(), (10, false));
assert_eq!((-10i32).overflowing_abs(), (10, false));
assert_eq!((i32::MIN).overflowing_abs(), (i32::MIN, true));

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!(3i32.overflowing_pow(4), (81, false));
assert_eq!(3i8.overflowing_pow(5), (-13, true));

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

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

Examples

Basic usage:

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

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

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!(10i32.isqrt(), 3);

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 the division results in overflow.

Examples

Basic usage:

let a: i32 = 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

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 the division results in overflow.

Examples

Basic usage:

let a: i32 = 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 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)]
let a: i32 = 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 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)]
let a: i32 = 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_i32.next_multiple_of(8), 16);
assert_eq!(23_i32.next_multiple_of(8), 24);
assert_eq!(16_i32.next_multiple_of(-8), 16);
assert_eq!(23_i32.next_multiple_of(-8), 16);
assert_eq!((-16_i32).next_multiple_of(8), -16);
assert_eq!((-23_i32).next_multiple_of(8), -16);
assert_eq!((-16_i32).next_multiple_of(-8), -16);
assert_eq!((-23_i32).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_i32.checked_next_multiple_of(8), Some(16));
assert_eq!(23_i32.checked_next_multiple_of(8), Some(24));
assert_eq!(16_i32.checked_next_multiple_of(-8), Some(16));
assert_eq!(23_i32.checked_next_multiple_of(-8), Some(16));
assert_eq!((-16_i32).checked_next_multiple_of(8), Some(-16));
assert_eq!((-23_i32).checked_next_multiple_of(8), Some(-16));
assert_eq!((-16_i32).checked_next_multiple_of(-8), Some(-16));
assert_eq!((-23_i32).checked_next_multiple_of(-8), Some(-24));
assert_eq!(1_i32.checked_next_multiple_of(0), None);
assert_eq!(i32::MAX.checked_next_multiple_of(2), None);

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!(0i32.midpoint(4), 2);
assert_eq!(0i32.midpoint(-1), -1);
assert_eq!((-1i32).midpoint(0), -1);

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!(5i32.ilog(5), 1);

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!(2i32.ilog2(), 1);

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!(10i32.ilog10(), 1);

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!(5i32.checked_ilog(5), Some(1));

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!(2i32.checked_ilog2(), Some(1));

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!(10i32.checked_ilog10(), Some(1));

pub const fn abs(self) -> Self

Computes the absolute value of self.

Overflow behavior

The absolute value of i32::MIN cannot be represented as an i32, 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 i32::MIN without a panic.

Examples

Basic usage:

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

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

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!(100i32.abs_diff(80), 20u32);
assert_eq!(100i32.abs_diff(110), 10u32);
assert_eq!((-100i32).abs_diff(80), 180u32);
assert_eq!((-100i32).abs_diff(-120), 20u32);
assert_eq!(i32::MIN.abs_diff(i32::MAX), u32::MAX);

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!(10i32.signum(), 1);
assert_eq!(0i32.signum(), 0);
assert_eq!((-10i32).signum(), -1);

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

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

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

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

Examples

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

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

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

Examples

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

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

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 = 0x12345678i32.to_ne_bytes();
assert_eq!(
    bytes,
    if cfg!(target_endian = "big") {
        [0x12, 0x34, 0x56, 0x78]
    } else {
        [0x78, 0x56, 0x34, 0x12]
    }
);

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

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

Examples

let value = i32::from_be_bytes([0x12, 0x34, 0x56, 0x78]);
assert_eq!(value, 0x12345678);

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

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

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

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

Examples

let value = i32::from_le_bytes([0x78, 0x56, 0x34, 0x12]);
assert_eq!(value, 0x12345678);

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

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

pub const fn from_ne_bytes(bytes: [u8; 4]) -> 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 = i32::from_ne_bytes(if cfg!(target_endian = "big") {
    [0x12, 0x34, 0x56, 0x78]
} else {
    [0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value, 0x12345678);

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

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

pub const fn min_value() -> Self

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

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

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

pub const fn max_value() -> Self

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

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

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

Trait Implementations

impl Add<&i32> for i32

type Output = <i32 as Add<i32>>::Output

The resulting type after applying the + operator.

fn add(self, other: &i32) -> <i32 as Add<i32>>::Output

Performs the + operation.

impl Add<i32> for i32

type Output = i32

The resulting type after applying the + operator.

fn add(self, other: i32) -> i32

Performs the + operation.

impl AddAssign<&i32> for i32

fn add_assign(&mut self, other: &i32)

Performs the += operation.

impl AddAssign<i32> for i32

fn add_assign(&mut self, other: i32)

Performs the += operation.

impl Binary for i32

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

Formats the value using the given formatter.

impl BitAnd<&i32> for i32

type Output = <i32 as BitAnd<i32>>::Output

The resulting type after applying the & operator.

fn bitand(self, other: &i32) -> <i32 as BitAnd<i32>>::Output

Performs the & operation.

impl BitAnd<i32> for i32

type Output = i32

The resulting type after applying the & operator.

fn bitand(self, rhs: i32) -> i32

Performs the & operation.

impl BitAndAssign<&i32> for i32

fn bitand_assign(&mut self, other: &i32)

Performs the &= operation.

impl BitAndAssign<i32> for i32

fn bitand_assign(&mut self, other: i32)

Performs the &= operation.

impl BitOr<&i32> for i32

type Output = <i32 as BitOr<i32>>::Output

The resulting type after applying the | operator.

fn bitor(self, other: &i32) -> <i32 as BitOr<i32>>::Output

Performs the | operation.

impl BitOr<NonZeroI32> for i32

type Output = NonZeroI32

The resulting type after applying the | operator.

fn bitor(self, rhs: NonZeroI32) -> Self::Output

Performs the | operation.

impl BitOr<i32> for i32

type Output = i32

The resulting type after applying the | operator.

fn bitor(self, rhs: i32) -> i32

Performs the | operation.

impl BitOrAssign<&i32> for i32

fn bitor_assign(&mut self, other: &i32)

Performs the |= operation.

impl BitOrAssign<i32> for i32

fn bitor_assign(&mut self, other: i32)

Performs the |= operation.

impl BitXor<&i32> for i32

type Output = <i32 as BitXor<i32>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, other: &i32) -> <i32 as BitXor<i32>>::Output

Performs the ^ operation.

impl BitXor<i32> for i32

type Output = i32

The resulting type after applying the ^ operator.

fn bitxor(self, other: i32) -> i32

Performs the ^ operation.

impl BitXorAssign<&i32> for i32

fn bitxor_assign(&mut self, other: &i32)

Performs the ^= operation.

impl BitXorAssign<i32> for i32

fn bitxor_assign(&mut self, other: i32)

Performs the ^= operation.

impl Clone for i32

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for i32

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

Formats the value using the given formatter.

impl Default for i32

fn default() -> i32

Returns the default value of 0

impl Display for i32

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

Formats the value using the given formatter.

impl Div<&i32> for i32

type Output = <i32 as Div<i32>>::Output

The resulting type after applying the / operator.

fn div(self, other: &i32) -> <i32 as Div<i32>>::Output

Performs the / operation.

impl Div<i32> for i32

This operation rounds towards zero, truncating any fractional part of the exact result.

Panics

This operation will panic if other == 0 or the division results in overflow.

type Output = i32

The resulting type after applying the / operator.

fn div(self, other: i32) -> i32

Performs the / operation.

impl DivAssign<&i32> for i32

fn div_assign(&mut self, other: &i32)

Performs the /= operation.

impl DivAssign<i32> for i32

fn div_assign(&mut self, other: i32)

Performs the /= operation.

impl From<NonZeroI32> for i32

fn from(nonzero: NonZeroI32) -> Self

Converts a NonZeroI32 into an i32

impl From<bool> for i32

fn from(small: bool) -> Self

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

Examples

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

impl From<i16> for i32

fn from(small: i16) -> Self

Converts i16 to i32 losslessly.

impl From<i8> for i32

fn from(small: i8) -> Self

Converts i8 to i32 losslessly.

impl From<u16> for i32

fn from(small: u16) -> Self

Converts u16 to i32 losslessly.

impl From<u8> for i32

fn from(small: u8) -> Self

Converts u8 to i32 losslessly.

impl FromStr for i32

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for i32

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerExp for i32

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

Formats the value using the given formatter.

impl LowerHex for i32

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

Formats the value using the given formatter.

impl Mul<&i32> for i32

type Output = <i32 as Mul<i32>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &i32) -> <i32 as Mul<i32>>::Output

Performs the * operation.

impl Mul<i32> for i32

type Output = i32

The resulting type after applying the * operator.

fn mul(self, other: i32) -> i32

Performs the * operation.

impl MulAssign<&i32> for i32

fn mul_assign(&mut self, other: &i32)

Performs the *= operation.

impl MulAssign<i32> for i32

fn mul_assign(&mut self, other: i32)

Performs the *= operation.

impl Neg for i32

type Output = i32

The resulting type after applying the - operator.

fn neg(self) -> i32

Performs the unary - operation.

impl Not for i32

type Output = i32

The resulting type after applying the ! operator.

fn not(self) -> i32

Performs the unary ! operation.

impl Octal for i32

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

Formats the value using the given formatter.

impl Ord for i32

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<i32> for i32

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

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

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

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

impl PartialOrd<i32> for i32

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

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

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

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

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

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

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

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

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

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

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

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

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

impl Product<i32> for i32

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

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

impl Rem<&i32> for i32

type Output = <i32 as Rem<i32>>::Output

The resulting type after applying the % operator.

fn rem(self, other: &i32) -> <i32 as Rem<i32>>::Output

Performs the % operation.

impl Rem<i32> for i32

This operation satisfies n % d == n - (n / d) * d. The result has the same sign as the left operand.

Panics

This operation will panic if other == 0 or if self / other results in overflow.

type Output = i32

The resulting type after applying the % operator.

fn rem(self, other: i32) -> i32

Performs the % operation.

impl RemAssign<&i32> for i32

fn rem_assign(&mut self, other: &i32)

Performs the %= operation.

impl RemAssign<i32> for i32

fn rem_assign(&mut self, other: i32)

Performs the %= operation.

impl Shl<&i128> for i32

type Output = <i32 as Shl<i128>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &i128) -> <i32 as Shl<i128>>::Output

Performs the << operation.

impl Shl<&i16> for i32

type Output = <i32 as Shl<i16>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &i16) -> <i32 as Shl<i16>>::Output

Performs the << operation.

impl Shl<&i32> for i32

type Output = <i32 as Shl<i32>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &i32) -> <i32 as Shl<i32>>::Output

Performs the << operation.

impl Shl<&i64> for i32

type Output = <i32 as Shl<i64>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &i64) -> <i32 as Shl<i64>>::Output

Performs the << operation.

impl Shl<&i8> for i32

type Output = <i32 as Shl<i8>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &i8) -> <i32 as Shl<i8>>::Output

Performs the << operation.

impl Shl<&isize> for i32

type Output = <i32 as Shl<isize>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &isize) -> <i32 as Shl<isize>>::Output

Performs the << operation.

impl Shl<&u128> for i32

type Output = <i32 as Shl<u128>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &u128) -> <i32 as Shl<u128>>::Output

Performs the << operation.

impl Shl<&u16> for i32

type Output = <i32 as Shl<u16>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &u16) -> <i32 as Shl<u16>>::Output

Performs the << operation.

impl Shl<&u32> for i32

type Output = <i32 as Shl<u32>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &u32) -> <i32 as Shl<u32>>::Output

Performs the << operation.

impl Shl<&u64> for i32

type Output = <i32 as Shl<u64>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &u64) -> <i32 as Shl<u64>>::Output

Performs the << operation.

impl Shl<&u8> for i32

type Output = <i32 as Shl<u8>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &u8) -> <i32 as Shl<u8>>::Output

Performs the << operation.

impl Shl<&usize> for i32

type Output = <i32 as Shl<usize>>::Output

The resulting type after applying the << operator.

fn shl(self, other: &usize) -> <i32 as Shl<usize>>::Output

Performs the << operation.

impl Shl<i128> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: i128) -> i32

Performs the << operation.

impl Shl<i16> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: i16) -> i32

Performs the << operation.

impl Shl<i32> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: i32) -> i32

Performs the << operation.

impl Shl<i64> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: i64) -> i32

Performs the << operation.

impl Shl<i8> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: i8) -> i32

Performs the << operation.

impl Shl<isize> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: isize) -> i32

Performs the << operation.

impl Shl<u128> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: u128) -> i32

Performs the << operation.

impl Shl<u16> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: u16) -> i32

Performs the << operation.

impl Shl<u32> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: u32) -> i32

Performs the << operation.

impl Shl<u64> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: u64) -> i32

Performs the << operation.

impl Shl<u8> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: u8) -> i32

Performs the << operation.

impl Shl<usize> for i32

type Output = i32

The resulting type after applying the << operator.

fn shl(self, other: usize) -> i32

Performs the << operation.

impl ShlAssign<&i128> for i32

fn shl_assign(&mut self, other: &i128)

Performs the <<= operation.

impl ShlAssign<&i16> for i32

fn shl_assign(&mut self, other: &i16)

Performs the <<= operation.

impl ShlAssign<&i32> for i32

fn shl_assign(&mut self, other: &i32)

Performs the <<= operation.

impl ShlAssign<&i64> for i32

fn shl_assign(&mut self, other: &i64)

Performs the <<= operation.

impl ShlAssign<&i8> for i32

fn shl_assign(&mut self, other: &i8)

Performs the <<= operation.

impl ShlAssign<&isize> for i32

fn shl_assign(&mut self, other: &isize)

Performs the <<= operation.

impl ShlAssign<&u128> for i32

fn shl_assign(&mut self, other: &u128)

Performs the <<= operation.

impl ShlAssign<&u16> for i32

fn shl_assign(&mut self, other: &u16)

Performs the <<= operation.

impl ShlAssign<&u32> for i32

fn shl_assign(&mut self, other: &u32)

Performs the <<= operation.

impl ShlAssign<&u64> for i32

fn shl_assign(&mut self, other: &u64)

Performs the <<= operation.

impl ShlAssign<&u8> for i32

fn shl_assign(&mut self, other: &u8)

Performs the <<= operation.

impl ShlAssign<&usize> for i32

fn shl_assign(&mut self, other: &usize)

Performs the <<= operation.

impl ShlAssign<i128> for i32

fn shl_assign(&mut self, other: i128)

Performs the <<= operation.

impl ShlAssign<i16> for i32

fn shl_assign(&mut self, other: i16)

Performs the <<= operation.

impl ShlAssign<i32> for i32

fn shl_assign(&mut self, other: i32)

Performs the <<= operation.

impl ShlAssign<i64> for i32

fn shl_assign(&mut self, other: i64)

Performs the <<= operation.

impl ShlAssign<i8> for i32

fn shl_assign(&mut self, other: i8)

Performs the <<= operation.

impl ShlAssign<isize> for i32

fn shl_assign(&mut self, other: isize)

Performs the <<= operation.

impl ShlAssign<u128> for i32

fn shl_assign(&mut self, other: u128)

Performs the <<= operation.

impl ShlAssign<u16> for i32

fn shl_assign(&mut self, other: u16)

Performs the <<= operation.

impl ShlAssign<u32> for i32

fn shl_assign(&mut self, other: u32)

Performs the <<= operation.

impl ShlAssign<u64> for i32

fn shl_assign(&mut self, other: u64)

Performs the <<= operation.

impl ShlAssign<u8> for i32

fn shl_assign(&mut self, other: u8)

Performs the <<= operation.

impl ShlAssign<usize> for i32

fn shl_assign(&mut self, other: usize)

Performs the <<= operation.

impl Shr<&i128> for i32

type Output = <i32 as Shr<i128>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &i128) -> <i32 as Shr<i128>>::Output

Performs the >> operation.

impl Shr<&i16> for i32

type Output = <i32 as Shr<i16>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &i16) -> <i32 as Shr<i16>>::Output

Performs the >> operation.

impl Shr<&i32> for i32

type Output = <i32 as Shr<i32>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &i32) -> <i32 as Shr<i32>>::Output

Performs the >> operation.

impl Shr<&i64> for i32

type Output = <i32 as Shr<i64>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &i64) -> <i32 as Shr<i64>>::Output

Performs the >> operation.

impl Shr<&i8> for i32

type Output = <i32 as Shr<i8>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &i8) -> <i32 as Shr<i8>>::Output

Performs the >> operation.

impl Shr<&isize> for i32

type Output = <i32 as Shr<isize>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &isize) -> <i32 as Shr<isize>>::Output

Performs the >> operation.

impl Shr<&u128> for i32

type Output = <i32 as Shr<u128>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &u128) -> <i32 as Shr<u128>>::Output

Performs the >> operation.

impl Shr<&u16> for i32

type Output = <i32 as Shr<u16>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &u16) -> <i32 as Shr<u16>>::Output

Performs the >> operation.

impl Shr<&u32> for i32

type Output = <i32 as Shr<u32>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &u32) -> <i32 as Shr<u32>>::Output

Performs the >> operation.

impl Shr<&u64> for i32

type Output = <i32 as Shr<u64>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &u64) -> <i32 as Shr<u64>>::Output

Performs the >> operation.

impl Shr<&u8> for i32

type Output = <i32 as Shr<u8>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &u8) -> <i32 as Shr<u8>>::Output

Performs the >> operation.

impl Shr<&usize> for i32

type Output = <i32 as Shr<usize>>::Output

The resulting type after applying the >> operator.

fn shr(self, other: &usize) -> <i32 as Shr<usize>>::Output

Performs the >> operation.

impl Shr<i128> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: i128) -> i32

Performs the >> operation.

impl Shr<i16> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: i16) -> i32

Performs the >> operation.

impl Shr<i32> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: i32) -> i32

Performs the >> operation.

impl Shr<i64> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: i64) -> i32

Performs the >> operation.

impl Shr<i8> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: i8) -> i32

Performs the >> operation.

impl Shr<isize> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: isize) -> i32

Performs the >> operation.

impl Shr<u128> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: u128) -> i32

Performs the >> operation.

impl Shr<u16> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: u16) -> i32

Performs the >> operation.

impl Shr<u32> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: u32) -> i32

Performs the >> operation.

impl Shr<u64> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: u64) -> i32

Performs the >> operation.

impl Shr<u8> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: u8) -> i32

Performs the >> operation.

impl Shr<usize> for i32

type Output = i32

The resulting type after applying the >> operator.

fn shr(self, other: usize) -> i32

Performs the >> operation.

impl ShrAssign<&i128> for i32

fn shr_assign(&mut self, other: &i128)

Performs the >>= operation.

impl ShrAssign<&i16> for i32

fn shr_assign(&mut self, other: &i16)

Performs the >>= operation.

impl ShrAssign<&i32> for i32

fn shr_assign(&mut self, other: &i32)

Performs the >>= operation.

impl ShrAssign<&i64> for i32

fn shr_assign(&mut self, other: &i64)

Performs the >>= operation.

impl ShrAssign<&i8> for i32

fn shr_assign(&mut self, other: &i8)

Performs the >>= operation.

impl ShrAssign<&isize> for i32

fn shr_assign(&mut self, other: &isize)

Performs the >>= operation.

impl ShrAssign<&u128> for i32

fn shr_assign(&mut self, other: &u128)

Performs the >>= operation.

impl ShrAssign<&u16> for i32

fn shr_assign(&mut self, other: &u16)

Performs the >>= operation.

impl ShrAssign<&u32> for i32

fn shr_assign(&mut self, other: &u32)

Performs the >>= operation.

impl ShrAssign<&u64> for i32

fn shr_assign(&mut self, other: &u64)

Performs the >>= operation.

impl ShrAssign<&u8> for i32

fn shr_assign(&mut self, other: &u8)

Performs the >>= operation.

impl ShrAssign<&usize> for i32

fn shr_assign(&mut self, other: &usize)

Performs the >>= operation.

impl ShrAssign<i128> for i32

fn shr_assign(&mut self, other: i128)

Performs the >>= operation.

impl ShrAssign<i16> for i32

fn shr_assign(&mut self, other: i16)

Performs the >>= operation.

impl ShrAssign<i32> for i32

fn shr_assign(&mut self, other: i32)

Performs the >>= operation.

impl ShrAssign<i64> for i32

fn shr_assign(&mut self, other: i64)

Performs the >>= operation.

impl ShrAssign<i8> for i32

fn shr_assign(&mut self, other: i8)

Performs the >>= operation.

impl ShrAssign<isize> for i32

fn shr_assign(&mut self, other: isize)

Performs the >>= operation.

impl ShrAssign<u128> for i32

fn shr_assign(&mut self, other: u128)

Performs the >>= operation.

impl ShrAssign<u16> for i32

fn shr_assign(&mut self, other: u16)

Performs the >>= operation.

impl ShrAssign<u32> for i32

fn shr_assign(&mut self, other: u32)

Performs the >>= operation.

impl ShrAssign<u64> for i32

fn shr_assign(&mut self, other: u64)

Performs the >>= operation.

impl ShrAssign<u8> for i32

fn shr_assign(&mut self, other: u8)

Performs the >>= operation.

impl ShrAssign<usize> for i32

fn shr_assign(&mut self, other: usize)

Performs the >>= operation.

impl SimdElement for i32

type Mask = i32

🔬This is a nightly-only experimental API. (portable_simd #86656)

The mask element type corresponding to this element type.

impl Step for i32

unsafe fn forward_unchecked(start: Self, n: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait #42168)

Returns the value that would be obtained by taking the successor of self count times.

unsafe fn backward_unchecked(start: Self, n: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait #42168)

Returns the value that would be obtained by taking the predecessor of self count times.

fn forward(start: Self, n: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait #42168)

Returns the value that would be obtained by taking the successor of self count times.

fn backward(start: Self, n: usize) -> Self

🔬This is a nightly-only experimental API. (step_trait #42168)

Returns the value that would be obtained by taking the predecessor of self count times.

fn steps_between(start: &Self, end: &Self) -> Option<usize>

🔬This is a nightly-only experimental API. (step_trait #42168)

Returns the number of successor steps required to get from start to end.

fn forward_checked(start: Self, n: usize) -> Option<Self>

🔬This is a nightly-only experimental API. (step_trait #42168)

Returns the value that would be obtained by taking the successor of self count times.

fn backward_checked(start: Self, n: usize) -> Option<Self>

🔬This is a nightly-only experimental API. (step_trait #42168)

Returns the value that would be obtained by taking the predecessor of self count times.

impl Sub<&i32> for i32

type Output = <i32 as Sub<i32>>::Output

The resulting type after applying the - operator.

fn sub(self, other: &i32) -> <i32 as Sub<i32>>::Output

Performs the - operation.

impl Sub<i32> for i32

type Output = i32

The resulting type after applying the - operator.

fn sub(self, other: i32) -> i32

Performs the - operation.

impl SubAssign<&i32> for i32

fn sub_assign(&mut self, other: &i32)

Performs the -= operation.

impl SubAssign<i32> for i32

fn sub_assign(&mut self, other: i32)

Performs the -= operation.

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

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

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

impl Sum<i32> for i32

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

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

impl TryFrom<i128> for i32

fn try_from(u: i128) -> Result<Self, Self::Error>

Try to create the target number type from a source number type. This returns an error if the source value is outside of the range of the target type.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<i64> for i32

fn try_from(u: i64) -> Result<Self, Self::Error>

Try to create the target number type from a source number type. This returns an error if the source value is outside of the range of the target type.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<isize> for i32

fn try_from(u: isize) -> Result<Self, Self::Error>

Try to create the target number type from a source number type. This returns an error if the source value is outside of the range of the target type.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<u128> for i32

fn try_from(u: u128) -> Result<Self, Self::Error>

Try to create the target number type from a source number type. This returns an error if the source value is outside of the range of the target type.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<u32> for i32

fn try_from(u: u32) -> Result<Self, Self::Error>

Try to create the target number type from a source number type. This returns an error if the source value is outside of the range of the target type.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<u64> for i32

fn try_from(u: u64) -> Result<Self, Self::Error>

Try to create the target number type from a source number type. This returns an error if the source value is outside of the range of the target type.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<usize> for i32

fn try_from(u: usize) -> Result<Self, Self::Error>

Try to create the target number type from a source number type. This returns an error if the source value is outside of the range of the target type.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl UpperExp for i32

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

Formats the value using the given formatter.

impl UpperHex for i32

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

Formats the value using the given formatter.

impl ConstParamTy for i32

impl Copy for i32

impl Eq for i32

impl MaskElement for i32

impl SimdCast for i32

impl StructuralEq for i32

impl StructuralPartialEq for i32

impl TrustedStep for i32