Primitive Type i1281.26.0[−]
Expand description
The 128-bit signed integer type.
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!(i128::from_str_radix("A", 16), Ok(10));
RunShifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting integer.
Please note this isn’t the same operation as the <<
shifting operator!
Examples
Basic usage:
let n = 0x13f40000000000000000000000004f76i128;
let m = 0x4f7613f4;
assert_eq!(n.rotate_left(16), m);
RunShifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting operator!
Examples
Basic usage:
let n = 0x4f7613f4i128;
let m = 0x13f40000000000000000000000004f76;
assert_eq!(n.rotate_right(16), m);
RunReverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.
Examples
Basic usage:
let n = 0x12345678901234567890123456789012i128;
let m = n.reverse_bits();
assert_eq!(m, 0x48091e6a2c48091e6a2c48091e6a2c48);
assert_eq!(0, 0i128.reverse_bits());
RunConverts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
let n = 0x1Ai128;
if cfg!(target_endian = "little") {
assert_eq!(i128::from_le(n), n)
} else {
assert_eq!(i128::from_le(n), n.swap_bytes())
}
Run🔬 This is a nightly-only experimental API. (unchecked_math
#85122)
niche optimization path
🔬 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 > i128::MAX
or self + rhs < i128::MIN
,
i.e. when checked_add
would return None
.
🔬 This is a nightly-only experimental API. (unchecked_math
#85122)
niche optimization path
🔬 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 > i128::MAX
or self - rhs < i128::MIN
,
i.e. when checked_sub
would return None
.
🔬 This is a nightly-only experimental API. (unchecked_math
#85122)
niche optimization path
🔬 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 > i128::MAX
or self * rhs < i128::MIN
,
i.e. when checked_mul
would return None
.
Checked integer division. Computes self / rhs
, returning None
if rhs == 0
or the division results in overflow.
Examples
Basic usage:
assert_eq!((i128::MIN + 1).checked_div(-1), Some(170141183460469231731687303715884105727));
assert_eq!(i128::MIN.checked_div(-1), None);
assert_eq!((1i128).checked_div(0), None);
RunChecked Euclidean division. Computes self.div_euclid(rhs)
,
returning None
if rhs == 0
or the division results in overflow.
Examples
Basic usage:
assert_eq!((i128::MIN + 1).checked_div_euclid(-1), Some(170141183460469231731687303715884105727));
assert_eq!(i128::MIN.checked_div_euclid(-1), None);
assert_eq!((1i128).checked_div_euclid(0), None);
Run🔬 This is a nightly-only experimental API. (unchecked_math
#85122)
niche optimization path
🔬 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
.
🔬 This is a nightly-only experimental API. (unchecked_math
#85122)
niche optimization path
🔬 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
.
Saturating integer negation. Computes -self
, returning MAX
if self == MIN
instead of overflowing.
Examples
Basic usage:
assert_eq!(100i128.saturating_neg(), -100);
assert_eq!((-100i128).saturating_neg(), 100);
assert_eq!(i128::MIN.saturating_neg(), i128::MAX);
assert_eq!(i128::MAX.saturating_neg(), i128::MIN + 1);
RunSaturating absolute value. Computes self.abs()
, returning MAX
if self == MIN
instead of overflowing.
Examples
Basic usage:
assert_eq!(100i128.saturating_abs(), 100);
assert_eq!((-100i128).saturating_abs(), 100);
assert_eq!(i128::MIN.saturating_abs(), i128::MAX);
assert_eq!((i128::MIN + 1).saturating_abs(), i128::MAX);
RunSaturating integer division. Computes self / rhs
, saturating at the
numeric bounds instead of overflowing.
Examples
Basic usage:
#![feature(saturating_div)]
assert_eq!(5i128.saturating_div(2), 2);
assert_eq!(i128::MAX.saturating_div(-1), i128::MIN + 1);
assert_eq!(i128::MIN.saturating_div(-1), i128::MAX);
Run#![feature(saturating_div)]
let _ = 1i128.saturating_div(0);
RunWrapping (modular) division. Computes self / rhs
, wrapping around at the
boundary of the type.
The only case where such wrapping can occur is when one divides MIN / -1
on a signed type (where
MIN
is the negative minimal value for the type); this is equivalent to -MIN
, a positive value
that is too large to represent in the type. In such a case, this function returns MIN
itself.
Panics
This function will panic if rhs
is 0.
Examples
Basic usage:
assert_eq!(100i128.wrapping_div(10), 10);
assert_eq!((-128i8).wrapping_div(-1), -128);
RunWrapping Euclidean division. Computes self.div_euclid(rhs)
,
wrapping around at the boundary of the type.
Wrapping will only occur in MIN / -1
on a signed type (where MIN
is the negative minimal value
for the type). This is equivalent to -MIN
, a positive value that is too large to represent in the
type. In this case, this method returns MIN
itself.
Panics
This function will panic if rhs
is 0.
Examples
Basic usage:
assert_eq!(100i128.wrapping_div_euclid(10), 10);
assert_eq!((-128i8).wrapping_div_euclid(-1), -128);
RunWrapping (modular) remainder. Computes self % rhs
, wrapping around at the
boundary of the type.
Such wrap-around never actually occurs mathematically; implementation artifacts make x % y
invalid for MIN / -1
on a signed type (where MIN
is the negative minimal value). In such a case,
this function returns 0
.
Panics
This function will panic if rhs
is 0.
Examples
Basic usage:
assert_eq!(100i128.wrapping_rem(10), 0);
assert_eq!((-128i8).wrapping_rem(-1), 0);
RunWrapping Euclidean remainder. Computes self.rem_euclid(rhs)
, wrapping around
at the boundary of the type.
Wrapping will only occur in MIN % -1
on a signed type (where MIN
is the negative minimal value
for the type). In this case, this method returns 0.
Panics
This function will panic if rhs
is 0.
Examples
Basic usage:
assert_eq!(100i128.wrapping_rem_euclid(10), 0);
assert_eq!((-128i8).wrapping_rem_euclid(-1), 0);
RunWrapping (modular) negation. Computes -self
, wrapping around at the boundary
of the type.
The only case where such wrapping can occur is when one negates MIN
on a signed type (where MIN
is the negative minimal value for the type); this is a positive value that is too large to represent
in the type. In such a case, this function returns MIN
itself.
Examples
Basic usage:
assert_eq!(100i128.wrapping_neg(), -100);
assert_eq!(i128::MIN.wrapping_neg(), i128::MIN);
RunPanic-free bitwise shift-left; yields self << mask(rhs)
, where mask
removes
any high-order bits of rhs
that would cause the shift to exceed the bitwidth of the type.
Note that this is not the same as a rotate-left; the RHS of a wrapping shift-left is restricted to
the range of the type, rather than the bits shifted out of the LHS being returned to the other end.
The primitive integer types all implement a rotate_left
function,
which may be what you want instead.
Examples
Basic usage:
assert_eq!((-1i128).wrapping_shl(7), -128);
assert_eq!((-1i128).wrapping_shl(128), -1);
RunPanic-free bitwise shift-right; yields self >> mask(rhs)
, where mask
removes any high-order bits of rhs
that would cause the shift to exceed the bitwidth of the type.
Note that this is not the same as a rotate-right; the RHS of a wrapping shift-right is restricted
to the range of the type, rather than the bits shifted out of the LHS being returned to the other
end. The primitive integer types all implement a rotate_right
function,
which may be what you want instead.
Examples
Basic usage:
assert_eq!((-128i128).wrapping_shr(7), -1);
assert_eq!((-128i16).wrapping_shr(64), -128);
RunWrapping (modular) absolute value. Computes self.abs()
, wrapping around at
the boundary of the type.
The only case where such wrapping can occur is when one takes the absolute value of the negative
minimal value for the type; this is a positive value that is too large to represent in the type. In
such a case, this function returns MIN
itself.
Examples
Basic usage:
assert_eq!(100i128.wrapping_abs(), 100);
assert_eq!((-100i128).wrapping_abs(), 100);
assert_eq!(i128::MIN.wrapping_abs(), i128::MIN);
assert_eq!((-128i8).wrapping_abs() as u8, 128);
RunCalculates self
+ rhs
Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.
Examples
Basic usage:
assert_eq!(5i128.overflowing_add(2), (7, false));
assert_eq!(i128::MAX.overflowing_add(1), (i128::MIN, true));
RunCalculates self + rhs + carry
without the ability to overflow.
Performs “ternary addition” which takes in an extra bit to add, and may return an additional bit of overflow. This allows for chaining together multiple additions to create “big integers” which represent larger values.
Examples
Basic usage
#![feature(bigint_helper_methods)]
assert_eq!(5i128.carrying_add(2, false), (7, false));
assert_eq!(5i128.carrying_add(2, true), (8, false));
assert_eq!(i128::MAX.carrying_add(1, false), (i128::MIN, false));
assert_eq!(i128::MAX.carrying_add(1, true), (i128::MIN + 1, false));
RunCalculates self
+ rhs
with an unsigned rhs
Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.
Examples
Basic usage:
assert_eq!(1i128.overflowing_add_unsigned(2), (3, false));
assert_eq!((i128::MIN).overflowing_add_unsigned(u128::MAX), (i128::MAX, false));
assert_eq!((i128::MAX - 2).overflowing_add_unsigned(3), (i128::MIN, true));
RunCalculates self
- rhs
Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.
Examples
Basic usage:
assert_eq!(5i128.overflowing_sub(2), (3, false));
assert_eq!(i128::MIN.overflowing_sub(1), (i128::MAX, true));
RunCalculates self - rhs - borrow
without the ability to overflow.
Performs “ternary subtraction” which takes in an extra bit to subtract, and may return an additional bit of overflow. This allows for chaining together multiple subtractions to create “big integers” which represent larger values.
Examples
Basic usage
#![feature(bigint_helper_methods)]
assert_eq!(5i128.borrowing_sub(2, false), (3, false));
assert_eq!(5i128.borrowing_sub(2, true), (2, false));
assert_eq!(i128::MIN.borrowing_sub(1, false), (i128::MAX, false));
assert_eq!(i128::MIN.borrowing_sub(1, true), (i128::MAX - 1, false));
RunCalculates self
- rhs
with an unsigned rhs
Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.
Examples
Basic usage:
assert_eq!(1i128.overflowing_sub_unsigned(2), (-1, false));
assert_eq!((i128::MAX).overflowing_sub_unsigned(u128::MAX), (i128::MIN, false));
assert_eq!((i128::MIN + 2).overflowing_sub_unsigned(3), (i128::MAX, true));
RunCalculates the multiplication of self
and rhs
.
Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.
Examples
Basic usage:
assert_eq!(5i128.overflowing_mul(2), (10, false));
assert_eq!(1_000_000_000i32.overflowing_mul(10), (1410065408, true));
RunCalculates the divisor when self
is divided by rhs
.
Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.
Panics
This function will panic if rhs
is 0.
Examples
Basic usage:
assert_eq!(5i128.overflowing_div(2), (2, false));
assert_eq!(i128::MIN.overflowing_div(-1), (i128::MIN, true));
RunCalculates the quotient of Euclidean division self.div_euclid(rhs)
.
Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would
occur. If an overflow would occur then self
is returned.
Panics
This function will panic if rhs
is 0.
Examples
Basic usage:
assert_eq!(5i128.overflowing_div_euclid(2), (2, false));
assert_eq!(i128::MIN.overflowing_div_euclid(-1), (i128::MIN, true));
RunCalculates the remainder when self
is divided by rhs
.
Returns a tuple of the remainder after dividing along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then 0 is returned.
Panics
This function will panic if rhs
is 0.
Examples
Basic usage:
assert_eq!(5i128.overflowing_rem(2), (1, false));
assert_eq!(i128::MIN.overflowing_rem(-1), (0, true));
RunOverflowing Euclidean remainder. Calculates self.rem_euclid(rhs)
.
Returns a tuple of the remainder after dividing along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then 0 is returned.
Panics
This function will panic if rhs
is 0.
Examples
Basic usage:
assert_eq!(5i128.overflowing_rem_euclid(2), (1, false));
assert_eq!(i128::MIN.overflowing_rem_euclid(-1), (0, true));
RunNegates self, overflowing if this is equal to the minimum value.
Returns a tuple of the negated version of self along with a boolean indicating whether an overflow
happened. If self
is the minimum value (e.g., i32::MIN
for values of type i32
), then the
minimum value will be returned again and true
will be returned for an overflow happening.
Examples
Basic usage:
assert_eq!(2i128.overflowing_neg(), (-2, false));
assert_eq!(i128::MIN.overflowing_neg(), (i128::MIN, true));
RunShifts self left by rhs
bits.
Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.
Examples
Basic usage:
assert_eq!(0x1i128.overflowing_shl(4), (0x10, false));
assert_eq!(0x1i32.overflowing_shl(36), (0x10, true));
RunShifts self right by rhs
bits.
Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.
Examples
Basic usage:
assert_eq!(0x10i128.overflowing_shr(4), (0x1, false));
assert_eq!(0x10i32.overflowing_shr(36), (0x1, true));
RunComputes the absolute value of self
.
Returns a tuple of the absolute version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g., i128::MIN for values of type i128), then the minimum value will be returned again and true will be returned for an overflow happening.
Examples
Basic usage:
assert_eq!(10i128.overflowing_abs(), (10, false));
assert_eq!((-10i128).overflowing_abs(), (10, false));
assert_eq!((i128::MIN).overflowing_abs(), (i128::MIN, true));
RunCalculates 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: i128 = 7; // or any other integer type
let b = 4;
assert_eq!(a.div_euclid(b), 1); // 7 >= 4 * 1
assert_eq!(a.div_euclid(-b), -1); // 7 >= -4 * -1
assert_eq!((-a).div_euclid(b), -2); // -7 >= 4 * -2
assert_eq!((-a).div_euclid(-b), 2); // -7 >= -4 * 2
RunCalculates 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: i128 = 7; // or any other integer type
let b = 4;
assert_eq!(a.rem_euclid(b), 3);
assert_eq!((-a).rem_euclid(b), 1);
assert_eq!(a.rem_euclid(-b), 3);
assert_eq!((-a).rem_euclid(-b), 1);
RunCalculates the quotient of self
and rhs
, rounding the result towards negative infinity.
Panics
This function will panic if rhs
is 0 or the division results in overflow.
Examples
Basic usage:
#![feature(int_roundings)]
let a: i128 = 8;
let b = 3;
assert_eq!(a.unstable_div_floor(b), 2);
assert_eq!(a.unstable_div_floor(-b), -3);
assert_eq!((-a).unstable_div_floor(b), -3);
assert_eq!((-a).unstable_div_floor(-b), 2);
RunCalculates the quotient of self
and rhs
, rounding the result towards positive infinity.
Panics
This function will panic if rhs
is 0 or the division results in overflow.
Examples
Basic usage:
#![feature(int_roundings)]
let a: i128 = 8;
let b = 3;
assert_eq!(a.unstable_div_ceil(b), 3);
assert_eq!(a.unstable_div_ceil(-b), -2);
assert_eq!((-a).unstable_div_ceil(b), -2);
assert_eq!((-a).unstable_div_ceil(-b), 3);
RunIf 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 0 or the operation results in overflow.
Examples
Basic usage:
#![feature(int_roundings)]
assert_eq!(16_i128.unstable_next_multiple_of(8), 16);
assert_eq!(23_i128.unstable_next_multiple_of(8), 24);
assert_eq!(16_i128.unstable_next_multiple_of(-8), 16);
assert_eq!(23_i128.unstable_next_multiple_of(-8), 16);
assert_eq!((-16_i128).unstable_next_multiple_of(8), -16);
assert_eq!((-23_i128).unstable_next_multiple_of(8), -16);
assert_eq!((-16_i128).unstable_next_multiple_of(-8), -16);
assert_eq!((-23_i128).unstable_next_multiple_of(-8), -24);
RunIf rhs
is positive, calculates the smallest value greater than or
equal to self
that is a multiple of rhs
. If rhs
is negative,
calculates the largest value less than or equal to self
that is a
multiple of rhs
. Returns None
if rhs
is zero or the operation
would result in overflow.
Examples
Basic usage:
#![feature(int_roundings)]
assert_eq!(16_i128.checked_next_multiple_of(8), Some(16));
assert_eq!(23_i128.checked_next_multiple_of(8), Some(24));
assert_eq!(16_i128.checked_next_multiple_of(-8), Some(16));
assert_eq!(23_i128.checked_next_multiple_of(-8), Some(16));
assert_eq!((-16_i128).checked_next_multiple_of(8), Some(-16));
assert_eq!((-23_i128).checked_next_multiple_of(8), Some(-16));
assert_eq!((-16_i128).checked_next_multiple_of(-8), Some(-16));
assert_eq!((-23_i128).checked_next_multiple_of(-8), Some(-24));
assert_eq!(1_i128.checked_next_multiple_of(0), None);
assert_eq!(i128::MAX.checked_next_multiple_of(2), None);
RunReturns the logarithm of the number with respect to an arbitrary base, rounded down.
This method might not be optimized owing to implementation details;
log2
can produce results more efficiently for base 2, and log10
can produce results more efficiently for base 10.
Panics
When the number is zero, or if the base is not at least 2; it panics in debug mode and the return value is 0 in release mode.
Examples
#![feature(int_log)]
assert_eq!(5i128.log(5), 1);
RunReturns 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_log2
can produce results more efficiently for base 2, and
checked_log10
can produce results more efficiently for base 10.
Examples
#![feature(int_log)]
assert_eq!(5i128.checked_log(5), Some(1));
RunComputes the absolute value of self
.
Overflow behavior
The absolute value of
i128::MIN
cannot be represented as an
i128
,
and attempting to calculate it will cause an overflow. This means
that code in debug mode will trigger a panic on this case and
optimized code will return
i128::MIN
without a panic.
Examples
Basic usage:
assert_eq!(10i128.abs(), 10);
assert_eq!((-10i128).abs(), 10);
RunComputes 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:
#![feature(int_abs_diff)]
assert_eq!(100i128.abs_diff(80), 20u128);
assert_eq!(100i128.abs_diff(110), 10u128);
assert_eq!((-100i128).abs_diff(80), 180u128);
assert_eq!((-100i128).abs_diff(-120), 20u128);
assert_eq!(i128::MIN.abs_diff(i128::MAX), u128::MAX);
RunReturn the memory representation of this integer as a byte array in native byte order.
As the target platform’s native endianness is used, portable code
should use to_be_bytes
or to_le_bytes
, as appropriate,
instead.
Examples
let bytes = 0x12345678901234567890123456789012i128.to_ne_bytes();
assert_eq!(
bytes,
if cfg!(target_endian = "big") {
[0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]
} else {
[0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
}
);
RunCreate an integer value from its representation as a byte array in big endian.
Examples
let value = i128::from_be_bytes([0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]);
assert_eq!(value, 0x12345678901234567890123456789012);
RunWhen starting from a slice rather than an array, fallible conversion APIs can be used:
use std::convert::TryInto;
fn read_be_i128(input: &mut &[u8]) -> i128 {
let (int_bytes, rest) = input.split_at(std::mem::size_of::<i128>());
*input = rest;
i128::from_be_bytes(int_bytes.try_into().unwrap())
}
RunCreate an integer value from its representation as a byte array in little endian.
Examples
let value = i128::from_le_bytes([0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]);
assert_eq!(value, 0x12345678901234567890123456789012);
RunWhen starting from a slice rather than an array, fallible conversion APIs can be used:
use std::convert::TryInto;
fn read_le_i128(input: &mut &[u8]) -> i128 {
let (int_bytes, rest) = input.split_at(std::mem::size_of::<i128>());
*input = rest;
i128::from_le_bytes(int_bytes.try_into().unwrap())
}
RunCreate an integer value from its memory representation as a byte array in native endianness.
As the target platform’s native endianness is used, portable code
likely wants to use from_be_bytes
or from_le_bytes
, as
appropriate instead.
Examples
let value = i128::from_ne_bytes(if cfg!(target_endian = "big") {
[0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12]
} else {
[0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
});
assert_eq!(value, 0x12345678901234567890123456789012);
RunWhen starting from a slice rather than an array, fallible conversion APIs can be used:
use std::convert::TryInto;
fn read_ne_i128(input: &mut &[u8]) -> i128 {
let (int_bytes, rest) = input.split_at(std::mem::size_of::<i128>());
*input = rest;
i128::from_ne_bytes(int_bytes.try_into().unwrap())
}
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
i128::MIN
instead.
Returns the smallest 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 = NonZeroI128
type Output = NonZeroI128
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 NonZeroI128
into an i128
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