# Struct core::num::NonZeroU128

1.28.0 · source ·

    pub struct NonZeroU128(/* private fields */);

Expand description

An integer that is known not to equal zero.

This enables some memory layout optimization. For example, `Option<NonZeroU128>` is the same size as `u128`:

    use std::mem::size_of;
    assert_eq!(size_of::<Option<core::num::NonZeroU128>>(), size_of::<u128>());

Run

## Layout

`NonZeroU128` is guaranteed to have the same layout and bit validity as `u128` with the exception that `0` is not a valid instance. `Option<NonZeroU128>` is guaranteed to be compatible with `u128`, including in FFI.

Thanks to the null pointer optimization, `NonZeroU128` and `Option<NonZeroU128>` are guaranteed to have the same size and alignment:

    use std::num::NonZeroU128;

    assert_eq!(size_of::<NonZeroU128>(), size_of::<Option<NonZeroU128>>());
    assert_eq!(align_of::<NonZeroU128>(), align_of::<Option<NonZeroU128>>());

Run

## Implementations§

source§

### impl NonZeroU128

const: 1.28.0 · source

#### pub const unsafe fn new_unchecked(n: u128) -> Self

Creates a non-zero without checking whether the value is non-zero. This results in undefined behaviour if the value is zero.

##### Safety

The value must not be zero.

const: 1.47.0 · source

#### pub const fn new(n: u128) -> Option<Self>

Creates a non-zero if the given value is not zero.

const: 1.34.0 · source

#### pub const fn get(self) -> u128

Returns the value as a primitive type.

source§

### impl NonZeroU128

1.53.0 (const: 1.53.0) · source

#### pub const fn leading_zeros(self) -> u32

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

On many architectures, this function can perform better than `leading_zeros()` on the underlying integer type, as special handling of zero can be avoided.

##### Examples

Basic usage:

    let n = std::num::NonZeroU128::new(u128::MAX).unwrap();

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

Run
1.53.0 (const: 1.53.0) · source

#### pub const fn trailing_zeros(self) -> u32

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

On many architectures, this function can perform better than `trailing_zeros()` on the underlying integer type, as special handling of zero can be avoided.

##### Examples

Basic usage:

    let n = std::num::NonZeroU128::new(0b0101000).unwrap();

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

Run
source§

### impl NonZeroU128

1.64.0 (const: 1.64.0) · source

#### pub const fn checked_add(self, other: u128) -> Option<NonZeroU128>

Adds an unsigned integer to a non-zero value. Checks for overflow and returns `None` on overflow. As a consequence, the result cannot wrap to zero.

##### Examples

    let one = NonZeroU128::new(1)?;
    let two = NonZeroU128::new(2)?;
    let max = NonZeroU128::new(u128::MAX)?;

    assert_eq!(Some(two), one.checked_add(1));
    assert_eq!(None, max.checked_add(1));

Run
1.64.0 (const: 1.64.0) · source

#### pub const fn saturating_add(self, other: u128) -> NonZeroU128

Adds an unsigned integer to a non-zero value. Return `NonZeroU128::MAX` on overflow.

##### Examples

    let one = NonZeroU128::new(1)?;
    let two = NonZeroU128::new(2)?;
    let max = NonZeroU128::new(u128::MAX)?;

    assert_eq!(two, one.saturating_add(1));
    assert_eq!(max, max.saturating_add(1));

Run
source

#### pub const unsafe fn unchecked_add(self, other: u128) -> NonZeroU128

🔬This is a nightly-only experimental API. (`nonzero_ops` #84186)

Adds an unsigned integer to a non-zero value, assuming overflow cannot occur. Overflow is unchecked, and it is undefined behaviour to overflow even if the result would wrap to a non-zero value. The behaviour is undefined as soon as `self + rhs > u128::MAX`.

##### Examples

    #![feature(nonzero_ops)]

    let one = NonZeroU128::new(1)?;
    let two = NonZeroU128::new(2)?;

    assert_eq!(two, unsafe { one.unchecked_add(1) });

Run
1.64.0 (const: 1.64.0) · source

#### pub const fn checked_next_power_of_two(self) -> Option<NonZeroU128>

Returns the smallest power of two greater than or equal to n. Checks for overflow and returns `None` if the next power of two is greater than the type’s maximum value. As a consequence, the result cannot wrap to zero.

##### Examples

    let two = NonZeroU128::new(2)?;
    let three = NonZeroU128::new(3)?;
    let four = NonZeroU128::new(4)?;
    let max = NonZeroU128::new(u128::MAX)?;

    assert_eq!(Some(two), two.checked_next_power_of_two() );
    assert_eq!(Some(four), three.checked_next_power_of_two() );
    assert_eq!(None, max.checked_next_power_of_two() );

Run
1.67.0 (const: 1.67.0) · source

#### pub const fn ilog2(self) -> u32

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

This is the same operation as `u128::ilog2`, except that it has no failure cases to worry about since this value can never be zero.

##### Examples

    assert_eq!(NonZeroU128::new(7).unwrap().ilog2(), 2);
    assert_eq!(NonZeroU128::new(8).unwrap().ilog2(), 3);
    assert_eq!(NonZeroU128::new(9).unwrap().ilog2(), 3);

Run
1.67.0 (const: 1.67.0) · source

#### pub const fn ilog10(self) -> u32

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

This is the same operation as `u128::ilog10`, except that it has no failure cases to worry about since this value can never be zero.

##### Examples

    assert_eq!(NonZeroU128::new(99).unwrap().ilog10(), 1);
    assert_eq!(NonZeroU128::new(100).unwrap().ilog10(), 2);
    assert_eq!(NonZeroU128::new(101).unwrap().ilog10(), 2);

Run
const: unstable · source

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

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

Calculates the middle point of `self` and `rhs`.

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

##### Examples

    #![feature(num_midpoint)]

    let one = NonZeroU128::new(1)?;
    let two = NonZeroU128::new(2)?;
    let four = NonZeroU128::new(4)?;

    assert_eq!(one.midpoint(four), two);
    assert_eq!(four.midpoint(one), two);

Run
source§

### impl NonZeroU128

1.64.0 (const: 1.64.0) · source

#### pub const fn checked_mul(self, other: NonZeroU128) -> Option<NonZeroU128>

Multiplies two non-zero integers together. Checks for overflow and returns `None` on overflow. As a consequence, the result cannot wrap to zero.

##### Examples

    let two = NonZeroU128::new(2)?;
    let four = NonZeroU128::new(4)?;
    let max = NonZeroU128::new(u128::MAX)?;

    assert_eq!(Some(four), two.checked_mul(two));
    assert_eq!(None, max.checked_mul(two));

Run
1.64.0 (const: 1.64.0) · source

#### pub const fn saturating_mul(self, other: NonZeroU128) -> NonZeroU128

Multiplies two non-zero integers together. Return `NonZeroU128::MAX` on overflow.

##### Examples

    let two = NonZeroU128::new(2)?;
    let four = NonZeroU128::new(4)?;
    let max = NonZeroU128::new(u128::MAX)?;

    assert_eq!(four, two.saturating_mul(two));
    assert_eq!(max, four.saturating_mul(max));

Run
source

#### pub const unsafe fn unchecked_mul(self, other: NonZeroU128) -> NonZeroU128

🔬This is a nightly-only experimental API. (`nonzero_ops` #84186)

Multiplies two non-zero integers together, assuming overflow cannot occur. Overflow is unchecked, and it is undefined behaviour to overflow even if the result would wrap to a non-zero value. The behaviour is undefined as soon as `self * rhs > u128::MAX`.

##### Examples

    #![feature(nonzero_ops)]

    let two = NonZeroU128::new(2)?;
    let four = NonZeroU128::new(4)?;

    assert_eq!(four, unsafe { two.unchecked_mul(two) });

Run
1.64.0 (const: 1.64.0) · source

#### pub const fn checked_pow(self, other: u32) -> Option<NonZeroU128>

Raises non-zero value to an integer power. Checks for overflow and returns `None` on overflow. As a consequence, the result cannot wrap to zero.

##### Examples

    let three = NonZeroU128::new(3)?;
    let twenty_seven = NonZeroU128::new(27)?;
    let half_max = NonZeroU128::new(u128::MAX / 2)?;

    assert_eq!(Some(twenty_seven), three.checked_pow(3));
    assert_eq!(None, half_max.checked_pow(3));

Run
1.64.0 (const: 1.64.0) · source

#### pub const fn saturating_pow(self, other: u32) -> NonZeroU128

Raise non-zero value to an integer power. Return `NonZeroU128::MAX` on overflow.

##### Examples

    let three = NonZeroU128::new(3)?;
    let twenty_seven = NonZeroU128::new(27)?;
    let max = NonZeroU128::new(u128::MAX)?;

    assert_eq!(twenty_seven, three.saturating_pow(3));
    assert_eq!(max, max.saturating_pow(3));

Run
source§

### impl NonZeroU128

1.59.0 (const: 1.59.0) · source

#### pub const fn is_power_of_two(self) -> bool

Returns `true` if and only if `self == (1 << k)` for some `k`.

On many architectures, this function can perform better than `is_power_of_two()` on the underlying integer type, as special handling of zero can be avoided.

##### Examples

Basic usage:

    let eight = std::num::NonZeroU128::new(8).unwrap();
    assert!(eight.is_power_of_two());
    let ten = std::num::NonZeroU128::new(10).unwrap();
    assert!(!ten.is_power_of_two());

Run
source§

### impl NonZeroU128

1.70.0 · source

#### pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, 1.

##### Examples

    assert_eq!(NonZeroU128::MIN.get(), 1u128);

Run
1.70.0 · source

#### pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to `u128::MAX`.

##### Examples

    assert_eq!(NonZeroU128::MAX.get(), u128::MAX);

Run
source§

### impl NonZeroU128

1.67.0 · source

#### pub const BITS: u32 = 128u32

The size of this non-zero integer type in bits.

This value is equal to `u128::BITS`.

##### Examples

    assert_eq!(NonZeroU128::BITS, u128::BITS);

Run

## Trait Implementations§

source§

### impl Binary for NonZeroU128

source§

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

Formats the value using the given formatter.
1.45.0 · source§

### impl BitOr<NonZeroU128> for u128

§

#### type Output = NonZeroU128

The resulting type after applying the `|` operator.
source§

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

Performs the `|` operation. Read more
1.45.0 · source§

### impl BitOr<u128> for NonZeroU128

§

#### type Output = NonZeroU128

The resulting type after applying the `|` operator.
source§

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

Performs the `|` operation. Read more
1.45.0 · source§

### impl BitOr for NonZeroU128

§

#### type Output = NonZeroU128

The resulting type after applying the `|` operator.
source§

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

Performs the `|` operation. Read more
1.45.0 · source§

### impl BitOrAssign<u128> for NonZeroU128

source§

#### fn bitor_assign(&mut self, rhs: u128)

Performs the `|=` operation. Read more
1.45.0 · source§

### impl BitOrAssign for NonZeroU128

source§

#### fn bitor_assign(&mut self, rhs: Self)

Performs the `|=` operation. Read more
source§

### impl Clone for NonZeroU128

source§

#### fn clone(&self) -> NonZeroU128

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for NonZeroU128

source§

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

Formats the value using the given formatter. Read more
source§

### impl Display for NonZeroU128

source§

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

Formats the value using the given formatter. Read more
1.51.0 · source§

### impl Div<NonZeroU128> for u128

source§

#### fn div(self, other: NonZeroU128) -> u128

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

§

#### type Output = u128

The resulting type after applying the `/` operator.
1.31.0 · source§

### impl From<NonZeroU128> for u128

source§

#### fn from(nonzero: NonZeroU128) -> Self

Converts a `NonZeroU128` into an `u128`

1.41.0 · source§

### impl From<NonZeroU16> for NonZeroU128

source§

#### fn from(small: NonZeroU16) -> Self

Converts `NonZeroU16` to `NonZeroU128` losslessly.

1.41.0 · source§

### impl From<NonZeroU32> for NonZeroU128

source§

#### fn from(small: NonZeroU32) -> Self

Converts `NonZeroU32` to `NonZeroU128` losslessly.

1.41.0 · source§

### impl From<NonZeroU64> for NonZeroU128

source§

#### fn from(small: NonZeroU64) -> Self

Converts `NonZeroU64` to `NonZeroU128` losslessly.

1.41.0 · source§

### impl From<NonZeroU8> for NonZeroU128

source§

#### fn from(small: NonZeroU8) -> Self

Converts `NonZeroU8` to `NonZeroU128` losslessly.

1.35.0 · source§

### impl FromStr for NonZeroU128

§

#### type Err = ParseIntError

The associated error which can be returned from parsing.
source§

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

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

### impl Hash for NonZeroU128

source§

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

Feeds this value into the given `Hasher`. Read more
1.3.0 · source§

#### fn hash_slice<H: Hasher>(data: &[Self], state: &mut H)
where Self: Sized,

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

### impl LowerHex for NonZeroU128

source§

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

Formats the value using the given formatter.
source§

### impl Octal for NonZeroU128

source§

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

Formats the value using the given formatter.
source§

### impl Ord for NonZeroU128

source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

### impl PartialEq for NonZeroU128

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

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

### impl PartialOrd for NonZeroU128

source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · source§

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

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
1.51.0 · source§

### impl Rem<NonZeroU128> for u128

source§

#### fn rem(self, other: NonZeroU128) -> u128

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

§

#### type Output = u128

The resulting type after applying the `%` operator.
1.49.0 · source§

### impl TryFrom<NonZeroI128> for NonZeroU128

source§

#### fn try_from(value: NonZeroI128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroI128` to `NonZeroU128`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroI16> for NonZeroU128

source§

#### fn try_from(value: NonZeroI16) -> Result<Self, Self::Error>

Attempts to convert `NonZeroI16` to `NonZeroU128`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroI32> for NonZeroU128

source§

#### fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert `NonZeroI32` to `NonZeroU128`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroI64> for NonZeroU128

source§

#### fn try_from(value: NonZeroI64) -> Result<Self, Self::Error>

Attempts to convert `NonZeroI64` to `NonZeroU128`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroI8> for NonZeroU128

source§

#### fn try_from(value: NonZeroI8) -> Result<Self, Self::Error>

Attempts to convert `NonZeroI8` to `NonZeroU128`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroIsize> for NonZeroU128

source§

#### fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>

Attempts to convert `NonZeroIsize` to `NonZeroU128`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroI128

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroI128`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroI16

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroI16`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroI32

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroI32`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroI64

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroI64`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroI8

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroI8`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroIsize

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroIsize`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroU16

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroU16`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroU32

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroU32`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroU64

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroU64`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroU8

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroU8`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroU128> for NonZeroUsize

source§

#### fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert `NonZeroU128` to `NonZeroUsize`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

### impl TryFrom<NonZeroUsize> for NonZeroU128

source§

#### fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>

Attempts to convert `NonZeroUsize` to `NonZeroU128`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
1.46.0 · source§

### impl TryFrom<u128> for NonZeroU128

source§

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

Attempts to convert `u128` to `NonZeroU128`.

§

#### type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

### impl UpperHex for NonZeroU128

source§

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

Formats the value using the given formatter.
source§

### impl Copy for NonZeroU128

source§

### impl Eq for NonZeroU128

source§

### impl StructuralEq for NonZeroU128

source§

### impl StructuralPartialEq for NonZeroU128

## Auto Trait Implementations§

§

### impl RefUnwindSafe for NonZeroU128

§

### impl Send for NonZeroU128

§

### impl Sync for NonZeroU128

§

### impl Unpin for NonZeroU128

§

### impl UnwindSafe for NonZeroU128

## Blanket Implementations§

source§

### impl<T> Any for T
where T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for T
where T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for T
where U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.