u128 - Rust (original) (raw)

Primitive Type u128

1.26.0· [−]

Expand description

The 128-bit unsigned integer type.

The smallest value that can be represented by this integer type.

Basic usage:

assert_eq!(u128::MIN, 0);

Run

The largest value that can be represented by this integer type, 2128 - 1.

Basic usage:

assert_eq!(u128::MAX, 340282366920938463463374607431768211455);

Run

The size of this integer type in bits.

assert_eq!(u128::BITS, 128);

Run

Converts a string slice in a given base to an integer.

The string is expected to be an optional + 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

This function panics if radix is not in the range from 2 to 36.

Basic usage:

assert_eq!(u128::from_str_radix("A", 16), Ok(10));

Run

1.0.0 (const: 1.32.0) · source

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

Basic usage:

let n = 0b01001100u128;

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

Run

1.0.0 (const: 1.32.0) · source

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

Basic usage:

assert_eq!(u128::MAX.count_zeros(), 0);

Run

1.0.0 (const: 1.32.0) · source

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

Basic usage:

let n = u128::MAX >> 2;

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

Run

1.0.0 (const: 1.32.0) · source

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

Basic usage:

let n = 0b0101000u128;

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

Run

1.46.0 (const: 1.46.0) · source

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

Basic usage:

let n = !(u128::MAX >> 2);

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

Run

1.46.0 (const: 1.46.0) · source

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

Basic usage:

let n = 0b1010111u128;

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

Run

1.0.0 (const: 1.32.0) · source

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!

Basic usage:

let n = 0x13f40000000000000000000000004f76u128;
let m = 0x4f7613f4;

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

Run

1.0.0 (const: 1.32.0) · source

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!

Basic usage:

let n = 0x4f7613f4u128;
let m = 0x13f40000000000000000000000004f76;

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

Run

1.0.0 (const: 1.32.0) · source

Reverses the byte order of the integer.

Basic usage:

let n = 0x12345678901234567890123456789012u128;
let m = n.swap_bytes();

assert_eq!(m, 0x12907856341290785634129078563412);

Run

1.37.0 (const: 1.37.0) · source

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.

Basic usage:

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

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

Run

1.0.0 (const: 1.32.0) · source

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.

Basic usage:

let n = 0x1Au128;

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

Run

1.0.0 (const: 1.32.0) · source

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.

Basic usage:

let n = 0x1Au128;

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

Run

1.0.0 (const: 1.32.0) · source

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.

Basic usage:

let n = 0x1Au128;

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

Run

1.0.0 (const: 1.32.0) · source

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.

Basic usage:

let n = 0x1Au128;

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

Run

1.0.0 (const: 1.47.0) · source

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

Basic usage:

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

Run

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

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

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

🔬 This is a nightly-only experimental API. (mixed_integer_ops #87840)

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

Basic usage:

assert_eq!(1u128.checked_add_signed(2), Some(3));
assert_eq!(1u128.checked_add_signed(-2), None);
assert_eq!((u128::MAX - 2).checked_add_signed(3), None);

Run

1.0.0 (const: 1.47.0) · source

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

Basic usage:

assert_eq!(1u128.checked_sub(1), Some(0));
assert_eq!(0u128.checked_sub(1), None);

Run

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

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

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

1.0.0 (const: 1.47.0) · source

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

Basic usage:

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

Run

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

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

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

1.0.0 (const: 1.52.0) · source

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

Basic usage:

assert_eq!(128u128.checked_div(2), Some(64));
assert_eq!(1u128.checked_div(0), None);

Run

1.38.0 (const: 1.52.0) · source

Checked Euclidean division. Computes self.div_euclid(rhs), returning Noneif rhs == 0.

Basic usage:

assert_eq!(128u128.checked_div_euclid(2), Some(64));
assert_eq!(1u128.checked_div_euclid(0), None);

Run

1.7.0 (const: 1.52.0) · source

Checked integer remainder. Computes self % rhs, returning Noneif rhs == 0.

Basic usage:

assert_eq!(5u128.checked_rem(2), Some(1));
assert_eq!(5u128.checked_rem(0), None);

Run

1.38.0 (const: 1.52.0) · source

Checked Euclidean modulo. Computes self.rem_euclid(rhs), returning Noneif rhs == 0.

Basic usage:

assert_eq!(5u128.checked_rem_euclid(2), Some(1));
assert_eq!(5u128.checked_rem_euclid(0), None);

Run

🔬 This is a nightly-only experimental API. (int_log #70887)

Returns 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 log10can produce results more efficiently for base 10.

When the number is negative, zero, or if the base is not at least 2; it panics in debug mode and the return value is 0 in release mode.

#![feature(int_log)]
assert_eq!(5u128.log(5), 1);

Run

🔬 This is a nightly-only experimental API. (int_log #70887)

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

When the number is negative or zero it panics in debug mode and the return value is 0 in release mode.

#![feature(int_log)]
assert_eq!(2u128.log2(), 1);

Run

🔬 This is a nightly-only experimental API. (int_log #70887)

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

When the number is negative or zero it panics in debug mode and the return value is 0 in release mode.

#![feature(int_log)]
assert_eq!(10u128.log10(), 1);

Run

🔬 This is a nightly-only experimental API. (int_log #70887)

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

Returns None if the number is 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, andchecked_log10 can produce results more efficiently for base 10.

#![feature(int_log)]
assert_eq!(5u128.checked_log(5), Some(1));

Run

🔬 This is a nightly-only experimental API. (int_log #70887)

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

Returns None if the number is zero.

#![feature(int_log)]
assert_eq!(2u128.checked_log2(), Some(1));

Run

🔬 This is a nightly-only experimental API. (int_log #70887)

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

Returns None if the number is zero.

#![feature(int_log)]
assert_eq!(10u128.checked_log10(), Some(1));

Run

1.7.0 (const: 1.47.0) · source

Checked negation. Computes -self, returning None unless self == 0.

Note that negating any positive integer will overflow.

Basic usage:

assert_eq!(0u128.checked_neg(), Some(0));
assert_eq!(1u128.checked_neg(), None);

Run

1.7.0 (const: 1.47.0) · source

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

Basic usage:

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

Run

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

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

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

1.7.0 (const: 1.47.0) · source

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

Basic usage:

assert_eq!(0x10u128.checked_shr(4), Some(0x1));
assert_eq!(0x10u128.checked_shr(129), None);

Run

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

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

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

1.34.0 (const: 1.50.0) · source

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

Basic usage:

assert_eq!(2u128.checked_pow(5), Some(32));
assert_eq!(u128::MAX.checked_pow(2), None);

Run

1.0.0 (const: 1.47.0) · source

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

Basic usage:

assert_eq!(100u128.saturating_add(1), 101);
assert_eq!(u128::MAX.saturating_add(127), u128::MAX);

Run

🔬 This is a nightly-only experimental API. (mixed_integer_ops #87840)

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

Basic usage:

assert_eq!(1u128.saturating_add_signed(2), 3);
assert_eq!(1u128.saturating_add_signed(-2), 0);
assert_eq!((u128::MAX - 2).saturating_add_signed(4), u128::MAX);

Run

1.0.0 (const: 1.47.0) · source

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

Basic usage:

assert_eq!(100u128.saturating_sub(27), 73);
assert_eq!(13u128.saturating_sub(127), 0);

Run

1.7.0 (const: 1.47.0) · source

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

Basic usage:

assert_eq!(2u128.saturating_mul(10), 20);
assert_eq!((u128::MAX).saturating_mul(10), u128::MAX);

Run

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

Basic usage:

assert_eq!(5u128.saturating_div(2), 2);

Run

let _ = 1u128.saturating_div(0);

Run

1.34.0 (const: 1.50.0) · source

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

Basic usage:

assert_eq!(4u128.saturating_pow(3), 64);
assert_eq!(u128::MAX.saturating_pow(2), u128::MAX);

Run

1.0.0 (const: 1.32.0) · source

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

Basic usage:

assert_eq!(200u128.wrapping_add(55), 255);
assert_eq!(200u128.wrapping_add(u128::MAX), 199);

Run

🔬 This is a nightly-only experimental API. (mixed_integer_ops #87840)

Wrapping (modular) addition with a signed integer. Computesself + rhs, wrapping around at the boundary of the type.

Basic usage:

assert_eq!(1u128.wrapping_add_signed(2), 3);
assert_eq!(1u128.wrapping_add_signed(-2), u128::MAX);
assert_eq!((u128::MAX - 2).wrapping_add_signed(4), 1);

Run

1.0.0 (const: 1.32.0) · source

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

Basic usage:

assert_eq!(100u128.wrapping_sub(100), 0);
assert_eq!(100u128.wrapping_sub(u128::MAX), 101);

Run

1.0.0 (const: 1.32.0) · source

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

Basic usage:

Please note that this example is shared between integer types. Which explains why u8 is used here.

assert_eq!(10u8.wrapping_mul(12), 120);
assert_eq!(25u8.wrapping_mul(12), 44);

Run

1.2.0 (const: 1.52.0) · source

Wrapping (modular) division. Computes self / rhs. Wrapped division on unsigned types is just normal division. There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations.

Basic usage:

assert_eq!(100u128.wrapping_div(10), 10);

Run

1.38.0 (const: 1.52.0) · source

Wrapping Euclidean division. Computes self.div_euclid(rhs). Wrapped division on unsigned types is just normal division. There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations. Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self.wrapping_div(rhs).

Basic usage:

assert_eq!(100u128.wrapping_div_euclid(10), 10);

Run

1.2.0 (const: 1.52.0) · source

Wrapping (modular) remainder. Computes self % rhs. Wrapped remainder calculation on unsigned types is just the regular remainder calculation. There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations.

Basic usage:

assert_eq!(100u128.wrapping_rem(10), 0);

Run

1.38.0 (const: 1.52.0) · source

Wrapping Euclidean modulo. Computes self.rem_euclid(rhs). Wrapped modulo calculation on unsigned types is just the regular remainder calculation. There’s no way wrapping could ever happen. This function exists, so that all operations are accounted for in the wrapping operations. Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self.wrapping_rem(rhs).

Basic usage:

assert_eq!(100u128.wrapping_rem_euclid(10), 0);

Run

1.2.0 (const: 1.32.0) · source

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

Since unsigned types do not have negative equivalents all applications of this function will wrap (except for -0). For values smaller than the corresponding signed type’s maximum the result is the same as casting the corresponding signed value. Any larger values are equivalent to MAX + 1 - (val - MAX - 1) whereMAX is the corresponding signed type’s maximum.

Basic usage:

Please note that this example is shared between integer types. Which explains why i8 is used here.

assert_eq!(100i8.wrapping_neg(), -100);
assert_eq!((-128i8).wrapping_neg(), -128);

Run

1.2.0 (const: 1.32.0) · source

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.

Basic usage:

assert_eq!(1u128.wrapping_shl(7), 128);
assert_eq!(1u128.wrapping_shl(128), 1);

Run

1.2.0 (const: 1.32.0) · source

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.

Basic usage:

assert_eq!(128u128.wrapping_shr(7), 1);
assert_eq!(128u128.wrapping_shr(128), 128);

Run

1.34.0 (const: 1.50.0) · source

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

Basic usage:

assert_eq!(3u128.wrapping_pow(5), 243);
assert_eq!(3u8.wrapping_pow(6), 217);

Run

1.7.0 (const: 1.32.0) · source

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.

Basic usage


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

Run

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

Calculates 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.

This can be thought of as a 128-bit “full adder”, in the electronics sense.

Basic usage

#![feature(bigint_helper_methods)]
assert_eq!(5u128.carrying_add(2, false), (7, false));
assert_eq!(5u128.carrying_add(2, true), (8, false));
assert_eq!(u128::MAX.carrying_add(1, false), (0, true));
assert_eq!(u128::MAX.carrying_add(0, true), (0, true));
assert_eq!(u128::MAX.carrying_add(1, true), (1, true));
assert_eq!(u128::MAX.carrying_add(u128::MAX, true), (u128::MAX, true));

Run

If carry is false, this method is equivalent to overflowing_add:

#![feature(bigint_helper_methods)]
assert_eq!(5_u128.carrying_add(2, false), 5_u128.overflowing_add(2));
assert_eq!(u128::MAX.carrying_add(1, false), u128::MAX.overflowing_add(1));

Run

🔬 This is a nightly-only experimental API. (mixed_integer_ops #87840)

Calculates self + rhs with a signed 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.

Basic usage:

assert_eq!(1u128.overflowing_add_signed(2), (3, false));
assert_eq!(1u128.overflowing_add_signed(-2), (u128::MAX, true));
assert_eq!((u128::MAX - 2).overflowing_add_signed(4), (1, true));

Run

1.7.0 (const: 1.32.0) · source

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.

Basic usage


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

Run

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

Calculates 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.

Basic usage

#![feature(bigint_helper_methods)]
assert_eq!(5u128.borrowing_sub(2, false), (3, false));
assert_eq!(5u128.borrowing_sub(2, true), (2, false));
assert_eq!(0u128.borrowing_sub(1, false), (u128::MAX, true));
assert_eq!(0u128.borrowing_sub(1, true), (u128::MAX - 1, true));

Run

🔬 This is a nightly-only experimental API. (int_abs_diff #89492)

Computes the absolute difference between self and other.

Basic usage:

#![feature(int_abs_diff)]
assert_eq!(100u128.abs_diff(80), 20u128);
assert_eq!(100u128.abs_diff(110), 10u128);

Run

1.7.0 (const: 1.32.0) · source

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.

Basic usage:

Please note that this example is shared between integer types. Which explains why u32 is used here.

assert_eq!(5u32.overflowing_mul(2), (10, false));
assert_eq!(1_000_000_000u32.overflowing_mul(10), (1410065408, true));

Run

1.7.0 (const: 1.52.0) · source

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. Note that for unsigned integers overflow never occurs, so the second value is alwaysfalse.

This function will panic if rhs is 0.

Basic usage

assert_eq!(5u128.overflowing_div(2), (2, false));

Run

1.38.0 (const: 1.52.0) · source

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. Note that for unsigned integers overflow never occurs, so the second value is alwaysfalse. Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self.overflowing_div(rhs).

This function will panic if rhs is 0.

Basic usage

assert_eq!(5u128.overflowing_div_euclid(2), (2, false));

Run

1.7.0 (const: 1.52.0) · source

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. Note that for unsigned integers overflow never occurs, so the second value is always false.

This function will panic if rhs is 0.

Basic usage

assert_eq!(5u128.overflowing_rem(2), (1, false));

Run

1.38.0 (const: 1.52.0) · source

Calculates the remainder self.rem_euclid(rhs) as if by Euclidean division.

Returns a tuple of the modulo after dividing along with a boolean indicating whether an arithmetic overflow would occur. Note that for unsigned integers overflow never occurs, so the second value is always false. Since, for the positive integers, all common definitions of division are equal, this operation is exactly equal to self.overflowing_rem(rhs).

This function will panic if rhs is 0.

Basic usage

assert_eq!(5u128.overflowing_rem_euclid(2), (1, false));

Run

1.7.0 (const: 1.32.0) · source

Negates self in an overflowing fashion.

Returns !self + 1 using wrapping operations to return the value that represents the negation of this unsigned value. Note that for positive unsigned values overflow always occurs, but negating 0 does not overflow.

Basic usage

assert_eq!(0u128.overflowing_neg(), (0, false));
assert_eq!(2u128.overflowing_neg(), (-2i32 as u128, true));

Run

1.7.0 (const: 1.32.0) · source

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.

Basic usage

assert_eq!(0x1u128.overflowing_shl(4), (0x10, false));
assert_eq!(0x1u128.overflowing_shl(132), (0x10, true));

Run

1.7.0 (const: 1.32.0) · source

Shifts self right by rhs bits.

Basic usage

assert_eq!(0x10u128.overflowing_shr(4), (0x1, false));
assert_eq!(0x10u128.overflowing_shr(132), (0x1, true));

Run

1.34.0 (const: 1.50.0) · source

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.

Basic usage:

assert_eq!(3u128.overflowing_pow(5), (243, false));
assert_eq!(3u8.overflowing_pow(6), (217, true));

Run

1.0.0 (const: 1.50.0) · source

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

Basic usage:

assert_eq!(2u128.pow(5), 32);

Run

1.38.0 (const: 1.52.0) · source

Performs Euclidean division.

Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self / rhs.

This function will panic if rhs is 0.

Basic usage:

assert_eq!(7u128.div_euclid(4), 1); // or any other integer type

Run

1.38.0 (const: 1.52.0) · source

Calculates the least remainder of self (mod rhs).

Since, for the positive integers, all common definitions of division are equal, this is exactly equal to self % rhs.

This function will panic if rhs is 0.

Basic usage:

assert_eq!(7u128.rem_euclid(4), 3); // or any other integer type

Run

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

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

This is the same as performing self / rhs for all unsigned integers.

This function will panic if rhs is 0.

Basic usage:

#![feature(int_roundings)]
assert_eq!(7_u128.div_floor(4), 1);

Run

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

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

This function will panic if rhs is 0.

Basic usage:

#![feature(int_roundings)]
assert_eq!(7_u128.div_ceil(4), 2);

Run

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

Calculates the smallest value greater than or equal to self that is a multiple of rhs.

This function will panic if rhs is 0 or the operation results in overflow.

Basic usage:

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

Run

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

Calculates the smallest value greater than or equal to self that is a multiple of rhs. Returns None is rhs is zero or the operation would result in overflow.

Basic usage:

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

Run

1.0.0 (const: 1.32.0) · source

Returns true if and only if self == 2^k for some k.

Basic usage:

assert!(16u128.is_power_of_two());
assert!(!10u128.is_power_of_two());

Run

1.0.0 (const: 1.50.0) · source

Returns the smallest power of two greater than or equal to self.

When return value overflows (i.e., self > (1 << (N-1)) for typeuN), it panics in debug mode and the return value is wrapped to 0 in release mode (the only situation in which method can return 0).

Basic usage:

assert_eq!(2u128.next_power_of_two(), 2);
assert_eq!(3u128.next_power_of_two(), 4);

Run

1.0.0 (const: 1.50.0) · source

Returns the smallest power of two greater than or equal to n. If the next power of two is greater than the type’s maximum value,None is returned, otherwise the power of two is wrapped in Some.

Basic usage:

assert_eq!(2u128.checked_next_power_of_two(), Some(2));
assert_eq!(3u128.checked_next_power_of_two(), Some(4));
assert_eq!(u128::MAX.checked_next_power_of_two(), None);

Run

🔬 This is a nightly-only experimental API. (wrapping_next_power_of_two #32463)

Returns the smallest power of two greater than or equal to n. If the next power of two is greater than the type’s maximum value, the return value is wrapped to 0.

Basic usage:

#![feature(wrapping_next_power_of_two)]

assert_eq!(2u128.wrapping_next_power_of_two(), 2);
assert_eq!(3u128.wrapping_next_power_of_two(), 4);
assert_eq!(u128::MAX.wrapping_next_power_of_two(), 0);

Run

1.32.0 (const: 1.44.0) · source

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

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

Run

1.32.0 (const: 1.44.0) · source

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

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

Run

1.32.0 (const: 1.44.0) · source

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.

let bytes = 0x12345678901234567890123456789012u128.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]
    }
);

Run

1.32.0 (const: 1.44.0) · source

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

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

Run

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

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

Run

1.32.0 (const: 1.44.0) · source

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

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

Run

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

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

Run

1.32.0 (const: 1.44.0) · source

Create a native endian 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.

let value = u128::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);

Run

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

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

Run

1.0.0 (const: 1.32.0) · source

👎 Deprecating in a future Rust version:

replaced by the MIN associated constant on this type

New code should prefer to useu128::MIN instead.

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

1.0.0 (const: 1.32.0) · source

👎 Deprecating in a future Rust version:

replaced by the MAX associated constant on this type

New code should prefer to useu128::MAX instead.

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

The resulting type after applying the + operator.

Formats the value using the given formatter.

The resulting type after applying the & operator.

The resulting type after applying the | operator.

The resulting type after applying the ^ operator.

Formats the value using the given formatter. Read more

Returns the default value of 0

Formats the value using the given formatter. Read more

The resulting type after applying the / operator.

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

The resulting type after applying the / operator.

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

This operation will panic if other == 0.

The resulting type after applying the / operator.

Basic usage:

#![feature(saturating_int_impl, saturating_int_assign_impl)]
use std::num::Saturating;

assert_eq!(Saturating(2u128), Saturating(5u128) / 2);
assert_eq!(Saturating(u128::MAX), Saturating(u128::MAX) / 1);
assert_eq!(Saturating(u128::MIN), Saturating(u128::MIN) / 1);

Run

#![feature(saturating_int_impl, saturating_int_assign_impl)]
use std::num::Saturating;

let _ = Saturating(0u128) / 0;

Run

The resulting type after applying the / operator.

Convert an Ipv6Addr into a host byte order u128.

use std:🥅:Ipv6Addr;

let addr = Ipv6Addr::new(
    0x1020, 0x3040, 0x5060, 0x7080,
    0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
);
assert_eq!(0x102030405060708090A0B0C0D0E0F00D_u128, u128::from(addr));

Run

Converts a NonZeroU128 into an u128

Converts a bool to a u128. The resulting value is 0 for false and 1 for truevalues.

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

Run

Converts a char into a u128.

use std::mem;

let c = '⚙';
let u = u128::from(c);
assert!(16 == mem::size_of_val(&u))

Run

Convert a host byte order u128 into an Ipv6Addr.

use std:🥅:Ipv6Addr;

let addr = Ipv6Addr::from(0x102030405060708090A0B0C0D0E0F00D_u128);
assert_eq!(
    Ipv6Addr::new(
        0x1020, 0x3040, 0x5060, 0x7080,
        0x90A0, 0xB0C0, 0xD0E0, 0xF00D,
    ),
    addr);

Run

Converts u16 to u128 losslessly.

Converts u32 to u128 losslessly.

Converts u64 to u128 losslessly.

Converts u8 to u128 losslessly.

The associated error which can be returned from parsing.

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

Formats the value using the given formatter.

The resulting type after applying the * operator.

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

The resulting type after applying the ! operator.

Performs the unary ! operation. Read more

Formats the value using the given formatter.

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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 method tests greater than (for self and other) and is used by the > operator. Read more

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

The resulting type after applying the % operator.

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

The resulting type after applying the % operator.

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

This operation will panic if other == 0.

The resulting type after applying the % operator.

The resulting type after applying the << operator.

The resulting type after applying the >> operator.

🔬 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. Read more

🔬 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. Read more

🔬 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. Read more

🔬 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. Read more

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

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

🔬 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. Read more

🔬 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. Read more

The resulting type after applying the - operator.

Method which takes an iterator and generates Self from the elements by “summing up” the items. 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

The type returned in the event of a conversion error.

Attempts to convert u128 to NonZeroU128.

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.

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.

The type returned in the event of a conversion error.

Formats the value using the given formatter.

impl Any for T where

T: 'static + ?Sized,

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

impl From for T

impl<T, U> Into for T where

U: From,

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into #41263)

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.