# Struct core::num::NonZeroU128 1.28.0[−][src]

#[repr(transparent)]pub struct NonZeroU128(_);

## 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

## Implementations

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

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

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

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:

#![feature(nonzero_is_power_of_two)] 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

## Trait Implementations

`type Output = NonZeroU128`

`type Output = NonZeroU128`

The resulting type after applying the `|`

operator.

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, and cannot panic.

`type Output = u128`

`type Output = u128`

The resulting type after applying the `/`

operator.

Converts a `NonZeroU128`

into an `u128`

Converts `NonZeroU16`

to `NonZeroU128`

losslessly.

Converts `NonZeroU32`

to `NonZeroU128`

losslessly.

Converts `NonZeroU64`

to `NonZeroU128`

losslessly.

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 (for `self`

and `other`

) and is used by the `>`

operator. Read more

This operation satisfies `n % d == n - (n / d) * d`

, and cannot panic.

`type Output = u128`

`type Output = u128`

The resulting type after applying the `%`

operator.

Attempts to convert `NonZeroI128`

to `NonZeroU128`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroI16`

to `NonZeroU128`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroI32`

to `NonZeroU128`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroI64`

to `NonZeroU128`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroIsize`

to `NonZeroU128`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroU8`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroU16`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroIsize`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroU32`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroU64`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroUsize`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroI8`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroI16`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroI32`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroI64`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroU128`

to `NonZeroI128`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

Attempts to convert `NonZeroUsize`

to `NonZeroU128`

.

`type Error = TryFromIntError`

`type Error = TryFromIntError`

The type returned in the event of a conversion error.