# Struct std::num::NonZeroU64
1.28.0[−][src]

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

Expand description

An integer that is known not to equal zero.

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

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

Run

## Implementations

[src]

### impl NonZeroU64

1.28.0 (const: 1.28.0)[src]

#### pub const unsafe fn new_unchecked(n: u64) -> NonZeroU64

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.

1.28.0 (const: 1.47.0)[src]

#### pub const fn new(n: u64) -> Option<NonZeroU64>

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

1.28.0 (const: 1.34.0)[src]

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

Returns the value as a primitive type.

[src]

### impl NonZeroU64

1.53.0 (const: 1.53.0)[src]

#### 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::NonZeroU64::new(u64::MAX).unwrap();

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

Run
1.53.0 (const: 1.53.0)[src]

#### 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::NonZeroU64::new(0b0101000).unwrap();

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

Run
[src]

### impl NonZeroU64

[src]

#### pub const fn checked_add(self, other: u64) -> Option<NonZeroU64>

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

Add an unsigned integer to a non-zero value. Check for overflow and return `None` on overflow As a consequence, the result cannot wrap to zero.

# Examples

    #![feature(nonzero_ops)]

    let one = NonZeroU64::new(1)?;
    let two = NonZeroU64::new(2)?;
    let max = NonZeroU64::new(u64::MAX)?;

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

Run
[src]

#### pub const fn saturating_add(self, other: u64) -> NonZeroU64

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

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

# Examples

    #![feature(nonzero_ops)]

    let one = NonZeroU64::new(1)?;
    let two = NonZeroU64::new(2)?;
    let max = NonZeroU64::new(u64::MAX)?;

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

Run
[src]

#### pub unsafe fn unchecked_add(self, other: u64) -> NonZeroU64

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

Add 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 > u64::MAX`.

# Examples

    #![feature(nonzero_ops)]

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

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

Run
[src]

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

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

Returns the smallest power of two greater than or equal to n. Check for overflow and return `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

    #![feature(nonzero_ops)]

    let two = NonZeroU64::new(2)?;
    let three = NonZeroU64::new(3)?;
    let four = NonZeroU64::new(4)?;
    let max = NonZeroU64::new(u64::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
[src]

### impl NonZeroU64

[src]

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

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

Multiply two non-zero integers together. Check for overflow and return `None` on overflow. As a consequence, the result cannot wrap to zero.

# Examples

    #![feature(nonzero_ops)]

    let two = NonZeroU64::new(2)?;
    let four = NonZeroU64::new(4)?;
    let max = NonZeroU64::new(u64::MAX)?;

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

Run
[src]

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

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

Multiply two non-zero integers together. Return `u64::MAX` on overflow.

# Examples

    #![feature(nonzero_ops)]

    let two = NonZeroU64::new(2)?;
    let four = NonZeroU64::new(4)?;
    let max = NonZeroU64::new(u64::MAX)?;

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

Run
[src]

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

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

Multiply 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 > u64::MAX`.

# Examples

    #![feature(nonzero_ops)]

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

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

Run
[src]

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

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

Raise non-zero value to an integer power. Check for overflow and return `None` on overflow. As a consequence, the result cannot wrap to zero.

# Examples

    #![feature(nonzero_ops)]

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

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

Run
[src]

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

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

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

# Examples

    #![feature(nonzero_ops)]

    let three = NonZeroU64::new(3)?;
    let twenty_seven = NonZeroU64::new(27)?;
    let max = NonZeroU64::new(u64::MAX)?;

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

Run
[src]

### impl NonZeroU64

[src]

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

🔬 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::NonZeroU64::new(8).unwrap();
    assert!(eight.is_power_of_two());
    let ten = std::num::NonZeroU64::new(10).unwrap();
    assert!(!ten.is_power_of_two());

Run

## Trait Implementations

[src]

### impl Binary for NonZeroU64

[src]

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

Formats the value using the given formatter.

1.45.0[src]

### impl BitOr<NonZeroU64> for u64

#### type Output = NonZeroU64

The resulting type after applying the `|` operator.

[src]

#### pub fn bitor(self, rhs: NonZeroU64) -> <u64 as BitOr<NonZeroU64>>::Output

Performs the `|` operation. Read more

1.45.0[src]

### impl BitOr<NonZeroU64> for NonZeroU64

#### type Output = NonZeroU64

The resulting type after applying the `|` operator.

[src]

#### pub fn bitor(self, rhs: NonZeroU64) -> <NonZeroU64 as BitOr<NonZeroU64>>::Output

Performs the `|` operation. Read more

1.45.0[src]

### impl BitOr<u64> for NonZeroU64

#### type Output = NonZeroU64

The resulting type after applying the `|` operator.

[src]

#### pub fn bitor(self, rhs: u64) -> <NonZeroU64 as BitOr<u64>>::Output

Performs the `|` operation. Read more

1.45.0[src]

### impl BitOrAssign<NonZeroU64> for NonZeroU64

[src]

#### pub fn bitor_assign(&mut self, rhs: NonZeroU64)

Performs the `|=` operation. Read more

1.45.0[src]

### impl BitOrAssign<u64> for NonZeroU64

[src]

#### pub fn bitor_assign(&mut self, rhs: u64)

Performs the `|=` operation. Read more

[src]

### impl Clone for NonZeroU64

[src]

#### pub fn clone(&self) -> NonZeroU64

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from `source`. Read more

[src]

### impl Debug for NonZeroU64

[src]

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

Formats the value using the given formatter. Read more

[src]

### impl Display for NonZeroU64

[src]

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

Formats the value using the given formatter. Read more

1.51.0[src]

### impl Div<NonZeroU64> for u64

[src]

#### pub fn div(self, other: NonZeroU64) -> u64

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

#### type Output = u64

The resulting type after applying the `/` operator.

1.41.0[src]

### impl From<NonZeroU16> for NonZeroU64

[src]

#### pub fn from(small: NonZeroU16) -> NonZeroU64

Converts `NonZeroU16` to `NonZeroU64` losslessly.

1.41.0[src]

### impl From<NonZeroU32> for NonZeroU64

[src]

#### pub fn from(small: NonZeroU32) -> NonZeroU64

Converts `NonZeroU32` to `NonZeroU64` losslessly.

1.41.0[src]

### impl From<NonZeroU64> for NonZeroU128

[src]

#### pub fn from(small: NonZeroU64) -> NonZeroU128

Converts `NonZeroU64` to `NonZeroU128` losslessly.

1.41.0[src]

### impl From<NonZeroU64> for NonZeroI128

[src]

#### pub fn from(small: NonZeroU64) -> NonZeroI128

Converts `NonZeroU64` to `NonZeroI128` losslessly.

1.31.0[src]

### impl From<NonZeroU64> for u64

[src]

#### pub fn from(nonzero: NonZeroU64) -> u64

Converts a `NonZeroU64` into an `u64`

1.41.0[src]

### impl From<NonZeroU8> for NonZeroU64

[src]

#### pub fn from(small: NonZeroU8) -> NonZeroU64

Converts `NonZeroU8` to `NonZeroU64` losslessly.

1.35.0[src]

### impl FromStr for NonZeroU64

#### type Err = ParseIntError

The associated error which can be returned from parsing.

[src]

#### pub fn from_str(src: &str) -> Result<NonZeroU64, <NonZeroU64 as FromStr>::Err>

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

[src]

### impl Hash for NonZeroU64

[src]

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

Feeds this value into the given `Hasher`. Read more

1.3.0[src]

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

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

[src]

### impl LowerHex for NonZeroU64

[src]

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

Formats the value using the given formatter.

[src]

### impl Octal for NonZeroU64

[src]

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

Formats the value using the given formatter.

[src]

### impl Ord for NonZeroU64

[src]

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

This method returns an `Ordering` between `self` and `other`. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

#### fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

[src]

### impl PartialEq<NonZeroU64> for NonZeroU64

[src]

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

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

[src]

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

This method tests for `!=`.

[src]

### impl PartialOrd<NonZeroU64> for NonZeroU64

[src]

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

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

1.0.0[src]

#### 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[src]

#### 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[src]

#### 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[src]

#### 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[src]

### impl Rem<NonZeroU64> for u64

[src]

#### pub fn rem(self, other: NonZeroU64) -> u64

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

#### type Output = u64

The resulting type after applying the `%` operator.

1.49.0[src]

### impl TryFrom<NonZeroI128> for NonZeroU64

[src]

#### pub fn try_from(
value: NonZeroI128
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI128>>::Error>

Attempts to convert `NonZeroI128` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroI16> for NonZeroU64

[src]

#### pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI16>>::Error>

Attempts to convert `NonZeroI16` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroI32> for NonZeroU64

[src]

#### pub fn try_from(
value: NonZeroI32
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI32>>::Error>

Attempts to convert `NonZeroI32` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroI64> for NonZeroU64

[src]

#### pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI64>>::Error>

Attempts to convert `NonZeroI64` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroI8> for NonZeroU64

[src]

#### pub fn try_from(
value: NonZeroI8
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI8>>::Error>

Attempts to convert `NonZeroI8` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroIsize> for NonZeroU64

[src]

#### pub fn try_from(
value: NonZeroIsize
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert `NonZeroIsize` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU128> for NonZeroU64

[src]

#### pub fn try_from(
value: NonZeroU128
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroU128>>::Error>

Attempts to convert `NonZeroU128` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU64> for NonZeroUsize

[src]

#### pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroU64>>::Error>

Attempts to convert `NonZeroU64` to `NonZeroUsize`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU64> for NonZeroI16

[src]

#### pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU64>>::Error>

Attempts to convert `NonZeroU64` to `NonZeroI16`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU64> for NonZeroI32

[src]

#### pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroU64>>::Error>

Attempts to convert `NonZeroU64` to `NonZeroI32`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU64> for NonZeroU32

[src]

#### pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroU64>>::Error>

Attempts to convert `NonZeroU64` to `NonZeroU32`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU64> for NonZeroI64

[src]

#### pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroU64>>::Error>

Attempts to convert `NonZeroU64` to `NonZeroI64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU64> for NonZeroIsize

[src]

#### pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroU64>>::Error>

Attempts to convert `NonZeroU64` to `NonZeroIsize`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU64> for NonZeroU8

[src]

#### pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroU64>>::Error>

Attempts to convert `NonZeroU64` to `NonZeroU8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU64> for NonZeroI8

[src]

#### pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroU64>>::Error>

Attempts to convert `NonZeroU64` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroU64> for NonZeroU16

[src]

#### pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroU64>>::Error>

Attempts to convert `NonZeroU64` to `NonZeroU16`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0[src]

### impl TryFrom<NonZeroUsize> for NonZeroU64

[src]

#### pub fn try_from(
value: NonZeroUsize
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroUsize>>::Error>

Attempts to convert `NonZeroUsize` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.46.0[src]

### impl TryFrom<u64> for NonZeroU64

[src]

#### pub fn try_from(
value: u64
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<u64>>::Error>

Attempts to convert `u64` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

[src]

### impl UpperHex for NonZeroU64

[src]

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

Formats the value using the given formatter.

[src]

### impl Copy for NonZeroU64

[src]

### impl Eq for NonZeroU64

[src]

### impl StructuralEq for NonZeroU64

[src]

### impl StructuralPartialEq for NonZeroU64

## Auto Trait Implementations

### impl RefUnwindSafe for NonZeroU64

### impl Send for NonZeroU64

### impl Sync for NonZeroU64

### impl Unpin for NonZeroU64

### impl UnwindSafe for NonZeroU64

## Blanket Implementations

[src]

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

[src]

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

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

[src]

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

[src]

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

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

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

[src]

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

Performs the conversion.

[src]

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

[src]

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

Performs the conversion.

[src]

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

[src]

#### pub fn to_owned(&self) -> T

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

[src]

#### pub fn clone_into(&self, target: &mut T)

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

recently added

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

[src]

### impl<T> ToString for T where
T: Display + ?Sized,

[src]

#### pub default fn to_string(&self) -> String

Converts the given value to a `String`. Read more

[src]

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

#### type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

[src]

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

Performs the conversion.