Struct core::num::NonZeroU64

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

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>());

Methods

impl NonZeroU64

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

Creates a non-zero without checking the value.

Safety

The value must not be zero.

pub fn new(n: u64) -> Option<Self>

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

pub const fn get(self) -> u64

Returns the value as a primitive type.

Trait Implementations

impl Copy for NonZeroU64

impl PartialEq<NonZeroU64> for NonZeroU64

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

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

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

This method tests for !=.

impl Eq for NonZeroU64

impl Ord for NonZeroU64

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp #44095)

Restrict a value to a certain interval.

impl PartialOrd<NonZeroU64> for NonZeroU64

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Clone for NonZeroU64

fn clone(&self) -> NonZeroU64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<NonZeroU64> for u64

fn from(nonzero: NonZeroU64) -> Self

Performs the conversion.

impl FromStr for NonZeroU64

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for NonZeroU64

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Debug for NonZeroU64

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for NonZeroU64

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Octal for NonZeroU64

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Binary for NonZeroU64

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl LowerHex for NonZeroU64

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl UpperHex for NonZeroU64

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.