# Primitive Type isize1.0.0[−]

## Expand description

The pointer-sized signed integer type.

The size of this primitive is how many bytes it takes to reference any location in memory. For example, on a 32 bit target, this is 4 bytes and on a 64 bit target, this is 8 bytes.

## Implementations

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

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn rotate_left(self, n: u32) -> isize

1.0.0 (const: 1.32.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn rotate_left(self, n: u32) -> isize

1.0.0 (const: 1.32.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn rotate_right(self, n: u32) -> isize

1.0.0 (const: 1.32.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn rotate_right(self, n: u32) -> isize

1.0.0 (const: 1.32.0)[src]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 = 0x6e10aaisize; let m = 0xaa00000000006e1; assert_eq!(n.rotate_right(12), m);Run

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 = 0x1234567890123456isize; let m = n.reverse_bits(); assert_eq!(m, 0x6a2c48091e6a2c48); assert_eq!(0, 0isize.reverse_bits());Run

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 = 0x1Aisize; if cfg!(target_endian = "big") { assert_eq!(isize::from_be(n), n) } else { assert_eq!(isize::from_be(n), n.swap_bytes()) }Run

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 = 0x1Aisize; if cfg!(target_endian = "little") { assert_eq!(isize::from_le(n), n) } else { assert_eq!(isize::from_le(n), n.swap_bytes()) }Run

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_add(self, rhs: isize) -> Option<isize>

1.0.0 (const: 1.47.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_add(self, rhs: isize) -> Option<isize>

1.0.0 (const: 1.47.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_add(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_add(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

Unchecked integer addition. Computes `self + rhs`

, assuming overflow
cannot occur.

# Safety

This results in undefined behavior when
`self + rhs > isize::MAX`

or `self + rhs < isize::MIN`

,
i.e. when `checked_add`

would return `None`

.

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_sub(self, rhs: isize) -> Option<isize>

1.0.0 (const: 1.47.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_sub(self, rhs: isize) -> Option<isize>

1.0.0 (const: 1.47.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_sub(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_sub(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

Unchecked integer subtraction. Computes `self - rhs`

, assuming overflow
cannot occur.

# Safety

This results in undefined behavior when
`self - rhs > isize::MAX`

or `self - rhs < isize::MIN`

,
i.e. when `checked_sub`

would return `None`

.

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_mul(self, rhs: isize) -> Option<isize>

1.0.0 (const: 1.47.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_mul(self, rhs: isize) -> Option<isize>

1.0.0 (const: 1.47.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_mul(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_mul(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

Unchecked integer multiplication. Computes `self * rhs`

, assuming overflow
cannot occur.

# Safety

This results in undefined behavior when
`self * rhs > isize::MAX`

or `self * rhs < isize::MIN`

,
i.e. when `checked_mul`

would return `None`

.

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_div(self, rhs: isize) -> Option<isize>

1.0.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_div(self, rhs: isize) -> Option<isize>

1.0.0 (const: 1.52.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_div_euclid(self, rhs: isize) -> Option<isize>

1.38.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_div_euclid(self, rhs: isize) -> Option<isize>

1.38.0 (const: 1.52.0)[src]Checked Euclidean division. Computes `self.div_euclid(rhs)`

,
returning `None`

if `rhs == 0`

or the division results in overflow.

# Examples

Basic usage:

assert_eq!((isize::MIN + 1).checked_div_euclid(-1), Some(9223372036854775807)); assert_eq!(isize::MIN.checked_div_euclid(-1), None); assert_eq!((1isize).checked_div_euclid(0), None);Run

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_rem(self, rhs: isize) -> Option<isize>

1.7.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_rem(self, rhs: isize) -> Option<isize>

1.7.0 (const: 1.52.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_rem_euclid(self, rhs: isize) -> Option<isize>

1.38.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_rem_euclid(self, rhs: isize) -> Option<isize>

1.38.0 (const: 1.52.0)[src]Checked Euclidean remainder. Computes `self.rem_euclid(rhs)`

, returning `None`

if `rhs == 0`

or the division results in overflow.

# Examples

Basic usage:

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

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_shl(self, rhs: u32) -> Option<isize>

1.7.0 (const: 1.47.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_shl(self, rhs: u32) -> Option<isize>

1.7.0 (const: 1.47.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_shl(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_shl(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

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`

.

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_shr(self, rhs: u32) -> Option<isize>

1.7.0 (const: 1.47.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_shr(self, rhs: u32) -> Option<isize>

1.7.0 (const: 1.47.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_shr(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const unsafe fn unchecked_shr(self, rhs: isize) -> isize

[src]## 🔬 This is a nightly-only experimental API. (`unchecked_math`

#85122)

niche optimization path

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`

.

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_pow(self, exp: u32) -> Option<isize>

1.34.0 (const: 1.50.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn checked_pow(self, exp: u32) -> Option<isize>

1.34.0 (const: 1.50.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn saturating_add(self, rhs: isize) -> isize

1.0.0 (const: 1.47.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn saturating_add(self, rhs: isize) -> isize

1.0.0 (const: 1.47.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn saturating_sub(self, rhs: isize) -> isize

1.0.0 (const: 1.47.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn saturating_sub(self, rhs: isize) -> isize

1.0.0 (const: 1.47.0)[src]Saturating integer negation. Computes `-self`

, returning `MAX`

if `self == MIN`

instead of overflowing.

# Examples

Basic usage:

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

Saturating absolute value. Computes `self.abs()`

, returning `MAX`

if `self == MIN`

instead of overflowing.

# Examples

Basic usage:

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

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn saturating_mul(self, rhs: isize) -> isize

1.7.0 (const: 1.47.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn saturating_mul(self, rhs: isize) -> isize

1.7.0 (const: 1.47.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn saturating_pow(self, exp: u32) -> isize

1.34.0 (const: 1.50.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn saturating_pow(self, exp: u32) -> isize

1.34.0 (const: 1.50.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_add(self, rhs: isize) -> isize

1.0.0 (const: 1.32.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_add(self, rhs: isize) -> isize

1.0.0 (const: 1.32.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_sub(self, rhs: isize) -> isize

1.0.0 (const: 1.32.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_sub(self, rhs: isize) -> isize

1.0.0 (const: 1.32.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_mul(self, rhs: isize) -> isize

1.0.0 (const: 1.32.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_mul(self, rhs: isize) -> isize

1.0.0 (const: 1.32.0)[src]#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_div(self, rhs: isize) -> isize

1.2.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_div(self, rhs: isize) -> isize

1.2.0 (const: 1.52.0)[src]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!(100isize.wrapping_div(10), 10); assert_eq!((-128i8).wrapping_div(-1), -128);Run

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_div_euclid(self, rhs: isize) -> isize

1.38.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_div_euclid(self, rhs: isize) -> isize

1.38.0 (const: 1.52.0)[src]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!(100isize.wrapping_div_euclid(10), 10); assert_eq!((-128i8).wrapping_div_euclid(-1), -128);Run

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_rem(self, rhs: isize) -> isize

1.2.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_rem(self, rhs: isize) -> isize

1.2.0 (const: 1.52.0)[src]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!(100isize.wrapping_rem(10), 0); assert_eq!((-128i8).wrapping_rem(-1), 0);Run

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_rem_euclid(self, rhs: isize) -> isize

1.38.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_rem_euclid(self, rhs: isize) -> isize

1.38.0 (const: 1.52.0)[src]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!(100isize.wrapping_rem_euclid(10), 0); assert_eq!((-128i8).wrapping_rem_euclid(-1), 0);Run

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

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_shl(self, rhs: u32) -> isize

1.2.0 (const: 1.32.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_shl(self, rhs: u32) -> isize

1.2.0 (const: 1.32.0)[src]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!((-1isize).wrapping_shl(7), -128); assert_eq!((-1isize).wrapping_shl(128), -1);Run

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_shr(self, rhs: u32) -> isize

1.2.0 (const: 1.32.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_shr(self, rhs: u32) -> isize

1.2.0 (const: 1.32.0)[src]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!((-128isize).wrapping_shr(7), -1); assert_eq!((-128i16).wrapping_shr(64), -128);Run

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

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_pow(self, exp: u32) -> isize

1.34.0 (const: 1.50.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn wrapping_pow(self, exp: u32) -> isize

1.34.0 (const: 1.50.0)[src]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!(5isize.overflowing_add(2), (7, false)); assert_eq!(isize::MAX.overflowing_add(1), (isize::MIN, true));Run

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

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

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

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

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

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

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

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

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

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., isize::MIN for values of type isize), then the minimum value will be returned again and true will be returned for an overflow happening.

# Examples

Basic usage:

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

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn div_euclid(self, rhs: isize) -> isize

1.38.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn div_euclid(self, rhs: isize) -> isize

1.38.0 (const: 1.52.0)[src]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: isize = 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 * 2Run

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn rem_euclid(self, rhs: isize) -> isize

1.38.0 (const: 1.52.0)[src]

#### #[must_use = "this returns the result of the operation, \ without modifying the original"]pub const fn rem_euclid(self, rhs: isize) -> isize

1.38.0 (const: 1.52.0)[src]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: isize = 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);Run

Computes the absolute value of `self`

.

# Overflow behavior

The absolute value of
`isize::MIN`

cannot be represented as an
`isize`

,
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
`isize::MIN`

without a panic.

# Examples

Basic usage:

assert_eq!(10isize.abs(), 10); assert_eq!((-10isize).abs(), 10);Run

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

**Note**: This function returns an array of length 2, 4 or 8 bytes
depending on the target pointer size.

# Examples

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

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

**Note**: This function returns an array of length 2, 4 or 8 bytes
depending on the target pointer size.

# Examples

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

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.

**Note**: This function returns an array of length 2, 4 or 8 bytes
depending on the target pointer size.

# Examples

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

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

**Note**: This function returns an array of length 2, 4 or 8 bytes
depending on the target pointer size.

# Examples

let value = isize::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56]); assert_eq!(value, 0x1234567890123456);Run

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

use std::convert::TryInto; fn read_be_isize(input: &mut &[u8]) -> isize { let (int_bytes, rest) = input.split_at(std::mem::size_of::<isize>()); *input = rest; isize::from_be_bytes(int_bytes.try_into().unwrap()) }Run

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

**Note**: This function returns an array of length 2, 4 or 8 bytes
depending on the target pointer size.

# Examples

let value = isize::from_le_bytes([0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]); assert_eq!(value, 0x1234567890123456);Run

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

use std::convert::TryInto; fn read_le_isize(input: &mut &[u8]) -> isize { let (int_bytes, rest) = input.split_at(std::mem::size_of::<isize>()); *input = rest; isize::from_le_bytes(int_bytes.try_into().unwrap()) }Run

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.

**Note**: This function returns an array of length 2, 4 or 8 bytes
depending on the target pointer size.

# Examples

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

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

use std::convert::TryInto; fn read_ne_isize(input: &mut &[u8]) -> isize { let (int_bytes, rest) = input.split_at(std::mem::size_of::<isize>()); *input = rest; isize::from_ne_bytes(int_bytes.try_into().unwrap()) }Run

## 👎 Deprecating in a future Rust version: replaced by the `MIN`

associated constant on this type

replaced by the `MIN`

associated constant on this type

New code should prefer to use
`isize::MIN`

instead.

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

## 👎 Deprecating in a future Rust version: replaced by the `MAX`

associated constant on this type

replaced by the `MAX`

associated constant on this type

New code should prefer to use
`isize::MAX`

instead.

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

## Trait Implementations

Performs the `+=`

operation. Read more

Performs the `+=`

operation. Read more

Performs the `&=`

operation. Read more

Performs the `&=`

operation. Read more

#### type Output = NonZeroIsize

#### type Output = NonZeroIsize

The resulting type after applying the `|`

operator.

Performs the `|`

operation. Read more

Performs the `|=`

operation. Read more

Performs the `|=`

operation. Read more

Performs the `^=`

operation. Read more

Performs the `^=`

operation. Read more

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.

Performs the `/=`

operation. Read more

Performs the `/=`

operation. Read more

Converts a `NonZeroIsize`

into an `isize`

#### type Err = ParseIntError

#### type Err = ParseIntError

The associated error which can be returned from parsing.

Performs the `*=`

operation. Read more

Performs the `*=`

operation. Read more

This method returns an ordering between `self`

and `other`

values if one exists. Read more

This method tests less than (for `self`

and `other`

) and is used by the `<`

operator. Read more

This method tests less than or equal to (for `self`

and `other`

) and is used by the `<=`

operator. Read more

This method tests greater than or equal to (for `self`

and `other`

) and is used by the `>=`

operator. Read more

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.

Performs the `%=`

operation. Read more

Performs the `%=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `<<=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

Performs the `>>=`

operation. Read more

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

#42168)

recently redesigned

Returns the value that would be obtained by taking the *successor*
of `self`

`count`

times. Read more

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

#42168)

recently redesigned

Returns the value that would be obtained by taking the *predecessor*
of `self`

`count`

times. Read more

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

#42168)

recently redesigned

Returns the value that would be obtained by taking the *successor*
of `self`

`count`

times. Read more

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

#42168)

recently redesigned

Returns the value that would be obtained by taking the *predecessor*
of `self`

`count`

times. Read more

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

#42168)

recently redesigned

Returns the number of *successor* steps required to get from `start`

to `end`

. Read more

Performs the `-=`

operation. Read more

Performs the `-=`

operation. Read more

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

#### type Error = TryFromIntError

The type returned in the event of a conversion 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

#### type Error = TryFromIntError

The type returned in the event of a conversion 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

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

#### type Error = TryFromIntError

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

#### type Error = TryFromIntError

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

#### type Error = TryFromIntError

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

#### type Error = TryFromIntError

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

#### type Error = TryFromIntError

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

## Auto Trait Implementations

### impl RefUnwindSafe for isize

### impl UnwindSafe for isize

## Blanket Implementations

Mutably borrows from an owned value. Read more