Struct core::num::NonZeroU64

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

已知不等于零的整数。

这样可以进行一些内存布局优化。 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>());

Layout

NonZeroU64 is guaranteed to have the same layout and bit validity as u64 除了 0 不是有效实例。 Option<NonZeroU64> is guaranteed to be compatible with u64, 包括在 FFI 中。

Implementations

impl NonZeroU64

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

创建一个非零值而不检查该值是否为非零值。 如果该值为零，这将导致未定义的行为。

Safety

该值不能为零。

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

如果给定值不为零，则创建一个非零值。

pub const fn get(self) -> u64

将值作为原始类型返回。

impl NonZeroU64

pub const fn leading_zeros(self) -> u32

返回 self 二进制表示形式中前导零的数目。

在许多体系结构上，此函数在底层整数类型上的性能优于 leading_zeros()，因为可以避免对零的特殊处理。

Examples

基本用法：

let n = std::num::NonZeroU64::new(u64::MAX).unwrap();

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

pub const fn trailing_zeros(self) -> u32

返回 self 二进制表示形式中的尾随零数。

在许多体系结构上，此函数在底层整数类型上的性能优于 trailing_zeros()，因为可以避免对零的特殊处理。

Examples

基本用法：

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

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

impl NonZeroU64

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

将无符号整数与非零值相加。 检查溢出并在溢出时返回 None。 因此，结果不能归零。

Examples

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

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

将无符号整数与非零值相加。 Return u64::MAX on overflow.

Examples

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

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

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

假设不会发生溢出，将无符号整数添加到非零值。 溢出未检查，如果结果将换行为非零值，则溢出 *even 是未定义的行为 *。

该行为是未定义的

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

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

返回大于或等于的最小二乘方 n. 如果下一个 2 的幂大于类型的最大值，则检查溢出并返回 None。 因此，结果不能归零。

Examples

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

pub const fn ilog2(self) -> u32

返回数字的以 2 为底的对数，向下取整。

这是相同的操作 u64::ilog2, 除了它没有需要担心的失败案例，因为这个值永远不会为零。

Examples

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

pub const fn ilog10(self) -> u32

返回数字的以 10 为底的对数，向下取整。

这是相同的操作 u64::ilog10, 除了它没有需要担心的失败案例，因为这个值永远不会为零。

Examples

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

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

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

计算 self 和 rhs 的中点。

midpoint(a, b) 是 (a + b) >> 1，就好像它是在足够大的带符号整数类型中执行的一样。 这意味着结果总是向 negative 无穷大舍入，并且永远不会发生溢出。

Examples

#![feature(num_midpoint)]

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

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

impl NonZeroU64

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

将两个非零整数相乘。 检查溢出并在溢出时返回 None。 因此，结果不能归零。

Examples

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

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

将两个非零整数相乘。 Return u64::MAX on overflow.

Examples

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

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

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

假设不会发生溢出，将两个非零整数相乘。 溢出未检查，如果结果将换行为非零值，则溢出 *even 是未定义的行为 *。

该行为是未定义的

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

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

将非零值提高到整数幂。 检查溢出并在溢出时返回 None。 因此，结果不能归零。

Examples

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

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

将非零值提高到整数幂。 Return u64::MAX on overflow.

Examples

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

impl NonZeroU64

pub const fn is_power_of_two(self) -> bool

当且仅当某些 k 的 self == (1 << k) 时，才返回 true。

在许多体系结构上，此函数在底层整数类型上的性能优于 is_power_of_two()，因为可以避免对零的特殊处理。

Examples

基本用法：

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

impl NonZeroU64

pub const MIN: Self = _

这个非零整数类型可以表示的最小值， 1.

Examples

assert_eq!(NonZeroU64::MIN.get(), 1u64);

pub const MAX: Self = _

这个非零整数类型可以表示的最大值，

equal to u64::MAX.

Examples

assert_eq!(NonZeroU64::MAX.get(), u64::MAX);

impl NonZeroU64

pub const BITS: u32 = 64u32

此非零整数类型的大小 (以位为单位)。

This value is equal to u64::BITS.

Examples

assert_eq!(NonZeroU64::BITS, u64::BITS);

Trait Implementations

impl Binary for NonZeroU64

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

使用给定的格式化程序格式化该值。

impl BitOr<NonZeroU64> for NonZeroU64

type Output = NonZeroU64

应用 | 运算符后的结果类型。

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

执行 | 操作。

impl BitOr<NonZeroU64> for u64

type Output = NonZeroU64

应用 | 运算符后的结果类型。

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

执行 | 操作。

impl BitOr<u64> for NonZeroU64

type Output = NonZeroU64

应用 | 运算符后的结果类型。

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

执行 | 操作。

impl BitOrAssign<NonZeroU64> for NonZeroU64

fn bitor_assign(&mut self, rhs: Self)

执行 |= 操作。

impl BitOrAssign<u64> for NonZeroU64

fn bitor_assign(&mut self, rhs: u64)

执行 |= 操作。

impl Clone for NonZeroU64

fn clone(&self) -> NonZeroU64

返回值的副本。

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

从 source 执行复制分配。

impl Debug for NonZeroU64

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

使用给定的格式化程序格式化该值。

impl Display for NonZeroU64

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

使用给定的格式化程序格式化该值。

impl Div<NonZeroU64> for u64

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

此运算将舍入为零，舍去精确结果的任何小数部分，并且不能为 panic。

type Output = u64

应用 / 运算符后的结果类型。

impl From<NonZeroU16> for NonZeroU64

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroU64 losslessly.

impl From<NonZeroU32> for NonZeroU64

fn from(small: NonZeroU32) -> Self

Converts NonZeroU32 to NonZeroU64 losslessly.

impl From<NonZeroU64> for NonZeroI128

fn from(small: NonZeroU64) -> Self

Converts NonZeroU64 to NonZeroI128 losslessly.

impl From<NonZeroU64> for NonZeroU128

fn from(small: NonZeroU64) -> Self

Converts NonZeroU64 to NonZeroU128 losslessly.

impl From<NonZeroU64> for u64

fn from(nonzero: NonZeroU64) -> Self

Converts a NonZeroU64 into an u64

impl From<NonZeroU8> for NonZeroU64

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroU64 losslessly.

impl FromStr for NonZeroU64

type Err = ParseIntError

可以从解析中返回的相关错误。

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

解析字符串 s 以返回此类型的值。

impl Hash for NonZeroU64

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

将该值输入给定的 Hasher。

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

将这种类型的切片送入给定的 Hasher 中。

impl LowerHex for NonZeroU64

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

使用给定的格式化程序格式化该值。

impl Octal for NonZeroU64

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

使用给定的格式化程序格式化该值。

impl Ord for NonZeroU64

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

此方法返回 self 和 other 之间的 Ordering。

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

比较并返回两个值中的最大值。

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

比较并返回两个值中的最小值。

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

将值限制在某个时间间隔内。

impl PartialEq<NonZeroU64> for NonZeroU64

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

此方法测试 self 和 other 值是否相等，并由 == 使用。

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

此方法测试 !=。 默认实现几乎总是足够的，并且不应在没有充分理由的情况下被覆盖。

impl PartialOrd<NonZeroU64> for NonZeroU64

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

如果存在，则此方法返回 self 和 other 值之间的顺序。

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

此方法测试的内容少于 (对于 self 和 other)，并且由 < 操作员使用。

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

此方法测试小于或等于 (对于 self 和 other)，并且由 <= 运算符使用。

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

此方法测试大于 (对于 self 和 other)，并且由 > 操作员使用。

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

此方法测试是否大于或等于 (对于 self 和 other)，并且由 >= 运算符使用。

impl Rem<NonZeroU64> for u64

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

此操作满足 n % d == n - (n / d) * d，但不能为 panic。

type Output = u64

应用 % 运算符后的结果类型。

impl TryFrom<NonZeroI128> for NonZeroU64

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

Attempts to convert NonZeroI128 to NonZeroU64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroI16> for NonZeroU64

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

Attempts to convert NonZeroI16 to NonZeroU64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroI32> for NonZeroU64

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

Attempts to convert NonZeroI32 to NonZeroU64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroI64> for NonZeroU64

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

Attempts to convert NonZeroI64 to NonZeroU64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroI8> for NonZeroU64

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

Attempts to convert NonZeroI8 to NonZeroU64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroIsize> for NonZeroU64

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

Attempts to convert NonZeroIsize to NonZeroU64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU128> for NonZeroU64

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

Attempts to convert NonZeroU128 to NonZeroU64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU64> for NonZeroI16

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

Attempts to convert NonZeroU64 to NonZeroI16.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU64> for NonZeroI32

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

Attempts to convert NonZeroU64 to NonZeroI32.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU64> for NonZeroI64

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

Attempts to convert NonZeroU64 to NonZeroI64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU64> for NonZeroI8

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

Attempts to convert NonZeroU64 to NonZeroI8.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU64> for NonZeroIsize

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

Attempts to convert NonZeroU64 to NonZeroIsize.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU64> for NonZeroU16

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

Attempts to convert NonZeroU64 to NonZeroU16.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU64> for NonZeroU32

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

Attempts to convert NonZeroU64 to NonZeroU32.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU64> for NonZeroU8

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

Attempts to convert NonZeroU64 to NonZeroU8.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroU64> for NonZeroUsize

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

Attempts to convert NonZeroU64 to NonZeroUsize.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<NonZeroUsize> for NonZeroU64

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

Attempts to convert NonZeroUsize to NonZeroU64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl TryFrom<u64> for NonZeroU64

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

Attempts to convert u64 to NonZeroU64.

type Error = TryFromIntError

发生转换错误时返回的类型。

impl UpperHex for NonZeroU64

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

使用给定的格式化程序格式化该值。

impl Copy for NonZeroU64

impl Eq for NonZeroU64

impl StructuralEq for NonZeroU64

impl StructuralPartialEq for NonZeroU64