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

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

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

impl NonZeroU128[src]

pub const unsafe fn new_unchecked(n: u128) -> Self1.28.0 (const: 1.34.0)[src]

Creates a non-zero without checking the value.

Safety

The value must not be zero.

pub const fn new(n: u128) -> Option<Self>1.28.0 (const: 1.47.0)[src]

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

pub const fn get(self) -> u1281.28.0 (const: 1.34.0)[src]

Returns the value as a primitive type.

impl NonZeroU128[src]

pub fn leading_zeros(self) -> u32[src]

🔬 This is a nightly-only experimental API. (nonzero_leading_trailing_zeros #79143)

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:

#![feature(nonzero_leading_trailing_zeros)]
let n = std::num::NonZeroU128::new(u128::MAX).unwrap();

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

pub fn trailing_zeros(self) -> u32[src]

🔬 This is a nightly-only experimental API. (nonzero_leading_trailing_zeros #79143)

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:

#![feature(nonzero_leading_trailing_zeros)]
let n = std::num::NonZeroU128::new(0b0101000).unwrap();

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

impl NonZeroU128[src]

pub const fn is_power_of_two(self) -> bool[src]

🔬 This is a nightly-only experimental API. (nonzero_is_power_of_two #81106)

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

impl Binary for NonZeroU128[src]

impl BitOr<NonZeroU128> for NonZeroU1281.45.0[src]

type Output = Self

The resulting type after applying the | operator.

impl BitOr<NonZeroU128> for u1281.45.0[src]

type Output = NonZeroU128

The resulting type after applying the | operator.

impl BitOr<u128> for NonZeroU1281.45.0[src]

type Output = Self

The resulting type after applying the | operator.

impl BitOrAssign<NonZeroU128> for NonZeroU1281.45.0[src]

impl BitOrAssign<u128> for NonZeroU1281.45.0[src]

impl Clone for NonZeroU128[src]

impl Copy for NonZeroU128[src]

impl Debug for NonZeroU128[src]

impl Display for NonZeroU128[src]

impl Div<NonZeroU128> for u1281.51.0[src]

type Output = u128

The resulting type after applying the / operator.

pub fn div(self, other: NonZeroU128) -> u128[src]

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

impl Eq for NonZeroU128[src]

impl From<NonZeroU128> for u1281.31.0[src]

pub fn from(nonzero: NonZeroU128) -> Self[src]

Converts a NonZeroU128 into an u128

impl From<NonZeroU16> for NonZeroU1281.41.0[src]

Converts NonZeroU16 to NonZeroU128 losslessly.

impl From<NonZeroU32> for NonZeroU1281.41.0[src]

Converts NonZeroU32 to NonZeroU128 losslessly.

impl From<NonZeroU64> for NonZeroU1281.41.0[src]

Converts NonZeroU64 to NonZeroU128 losslessly.

impl From<NonZeroU8> for NonZeroU1281.41.0[src]

Converts NonZeroU8 to NonZeroU128 losslessly.

impl FromStr for NonZeroU1281.35.0[src]

type Err = ParseIntError

The associated error which can be returned from parsing.

impl Hash for NonZeroU128[src]

impl LowerHex for NonZeroU128[src]

impl Octal for NonZeroU128[src]

impl Ord for NonZeroU128[src]

impl PartialEq<NonZeroU128> for NonZeroU128[src]

impl PartialOrd<NonZeroU128> for NonZeroU128[src]

impl Rem<NonZeroU128> for u1281.51.0[src]

type Output = u128

The resulting type after applying the % operator.

pub fn rem(self, other: NonZeroU128) -> u128[src]

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

impl StructuralEq for NonZeroU128[src]

impl StructuralPartialEq for NonZeroU128[src]

impl TryFrom<NonZeroI128> for NonZeroU1281.49.0[src]

Attempts to convert NonZeroI128 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI16> for NonZeroU1281.49.0[src]

Attempts to convert NonZeroI16 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU1281.49.0[src]

Attempts to convert NonZeroI32 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroU1281.49.0[src]

Attempts to convert NonZeroI64 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI8> for NonZeroU1281.49.0[src]

Attempts to convert NonZeroI8 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroIsize> for NonZeroU1281.49.0[src]

Attempts to convert NonZeroIsize to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroU81.49.0[src]

Attempts to convert NonZeroU128 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroU161.49.0[src]

Attempts to convert NonZeroU128 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroIsize1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroU321.49.0[src]

Attempts to convert NonZeroU128 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroU641.49.0[src]

Attempts to convert NonZeroU128 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroUsize1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroI81.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroI161.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroI321.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroI641.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroI1281.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroUsize> for NonZeroU1281.49.0[src]

Attempts to convert NonZeroUsize to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<u128> for NonZeroU1281.46.0[src]

Attempts to convert u128 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl UpperHex for NonZeroU128[src]

Auto Trait Implementations

impl Send for NonZeroU128[src]

impl Sync for NonZeroU128[src]

impl Unpin for NonZeroU128[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.