Struct std::num::NonZeroIsize

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

已知不等于零的整数。

这样可以进行一些内存布局优化。 For example, Option<NonZeroIsize> is the same size as isize:

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

Layout

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

Implementations

impl NonZeroIsize

pub const unsafe fn new_unchecked(n: isize) -> NonZeroIsize

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

Safety

该值不能为零。

pub const fn new(n: isize) -> Option<NonZeroIsize>

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

pub const fn get(self) -> isize

将值作为原始类型返回。

impl NonZeroIsize

pub const fn leading_zeros(self) -> u32

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

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

Examples

基本用法：

let n = std::num::NonZeroIsize::new(-1isize).unwrap();

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

pub const fn trailing_zeros(self) -> u32

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

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

Examples

基本用法：

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

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

impl NonZeroIsize

pub const fn abs(self) -> NonZeroIsize

计算 self 的绝对值。 See isize::abs 有关溢出行为的文档。

Example

let pos = NonZeroIsize::new(1)?;
let neg = NonZeroIsize::new(-1)?;

assert_eq!(pos, pos.abs());
assert_eq!(pos, neg.abs());

pub const fn checked_abs(self) -> Option<NonZeroIsize>

检查的绝对值。 检查溢出并返回 None 如果 self == isize::MIN. 结果不能为零。

Example

let pos = NonZeroIsize::new(1)?;
let neg = NonZeroIsize::new(-1)?;
let min = NonZeroIsize::new(isize::MIN)?;

assert_eq!(Some(pos), neg.checked_abs());
assert_eq!(None, min.checked_abs());

pub const fn overflowing_abs(self) -> (NonZeroIsize, bool)

计算 self 的绝对值，带有溢出信息，请参见

isize::overflowing_abs.

Example

let pos = NonZeroIsize::new(1)?;
let neg = NonZeroIsize::new(-1)?;
let min = NonZeroIsize::new(isize::MIN)?;

assert_eq!((pos, false), pos.overflowing_abs());
assert_eq!((pos, false), neg.overflowing_abs());
assert_eq!((min, true), min.overflowing_abs());

pub const fn saturating_abs(self) -> NonZeroIsize

饱和绝对值，请参见 isize::saturating_abs.

Example

let pos = NonZeroIsize::new(1)?;
let neg = NonZeroIsize::new(-1)?;
let min = NonZeroIsize::new(isize::MIN)?;
let min_plus = NonZeroIsize::new(isize::MIN + 1)?;
let max = NonZeroIsize::new(isize::MAX)?;

assert_eq!(pos, pos.saturating_abs());
assert_eq!(pos, neg.saturating_abs());
assert_eq!(max, min.saturating_abs());
assert_eq!(max, min_plus.saturating_abs());

pub const fn wrapping_abs(self) -> NonZeroIsize

包装绝对值，请参见 isize::wrapping_abs.

Example

let pos = NonZeroIsize::new(1)?;
let neg = NonZeroIsize::new(-1)?;
let min = NonZeroIsize::new(isize::MIN)?;

assert_eq!(pos, pos.wrapping_abs());
assert_eq!(pos, neg.wrapping_abs());
assert_eq!(min, min.wrapping_abs());
assert_eq!(max, (-max).wrapping_abs());

pub const fn unsigned_abs(self) -> NonZeroUsize

在没有任何包装或 panicking 的情况下计算 self 的绝对值。

Example

let u_pos = NonZeroUsize::new(1)?;
let i_pos = NonZeroIsize::new(1)?;
let i_neg = NonZeroIsize::new(-1)?;
let i_min = NonZeroIsize::new(isize::MIN)?;
let u_max = NonZeroUsize::new(usize::MAX / 2 + 1)?;

assert_eq!(u_pos, i_pos.unsigned_abs());
assert_eq!(u_pos, i_neg.unsigned_abs());
assert_eq!(u_max, i_min.unsigned_abs());

pub const fn is_positive(self) -> bool

如果 self 为正，则返回 true; 如果数字为 negative，则返回 false。

Example

let pos_five = NonZeroIsize::new(5)?;
let neg_five = NonZeroIsize::new(-5)?;

assert!(pos_five.is_positive());
assert!(!neg_five.is_positive());

pub const fn is_negative(self) -> bool

如果 self 为 negative，则返回 true; 如果数字为正，则返回 false。

Example

let pos_five = NonZeroIsize::new(5)?;
let neg_five = NonZeroIsize::new(-5)?;

assert!(neg_five.is_negative());
assert!(!pos_five.is_negative());

pub const fn checked_neg(self) -> Option<NonZeroIsize>

检查否定。计算 -self，如果 self == i32::MIN 返回 None。

Example

let pos_five = NonZeroIsize::new(5)?;
let neg_five = NonZeroIsize::new(-5)?;
let min = NonZeroIsize::new(isize::MIN)?;

assert_eq!(pos_five.checked_neg(), Some(neg_five));
assert_eq!(min.checked_neg(), None);

pub const fn overflowing_neg(self) -> (NonZeroIsize, bool)

否定 self，如果等于最小值，则溢出。

See isize::overflowing_neg 有关溢出行为的文档。

Example

let pos_five = NonZeroIsize::new(5)?;
let neg_five = NonZeroIsize::new(-5)?;
let min = NonZeroIsize::new(isize::MIN)?;

assert_eq!(pos_five.overflowing_neg(), (neg_five, false));
assert_eq!(min.overflowing_neg(), (min, true));

pub const fn saturating_neg(self) -> NonZeroIsize

饱和否定。计算 -self，如果 self == i32::MIN 而不是溢出则返回 MAX。

Example

let pos_five = NonZeroIsize::new(5)?;
let neg_five = NonZeroIsize::new(-5)?;
let min = NonZeroIsize::new(isize::MIN)?;
let min_plus_one = NonZeroIsize::new(isize::MIN + 1)?;
let max = NonZeroIsize::new(isize::MAX)?;

assert_eq!(pos_five.saturating_neg(), neg_five);
assert_eq!(min.saturating_neg(), max);
assert_eq!(max.saturating_neg(), min_plus_one);

pub const fn wrapping_neg(self) -> NonZeroIsize

包装 (modular) 取反。 计算 -self，在类型的边界处回绕。

See isize::wrapping_neg 有关溢出行为的文档。

Example

let pos_five = NonZeroIsize::new(5)?;
let neg_five = NonZeroIsize::new(-5)?;
let min = NonZeroIsize::new(isize::MIN)?;

assert_eq!(pos_five.wrapping_neg(), neg_five);
assert_eq!(min.wrapping_neg(), min);

impl NonZeroIsize

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

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

Examples

let two = NonZeroIsize::new(2)?;
let four = NonZeroIsize::new(4)?;
let max = NonZeroIsize::new(isize::MAX)?;

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

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

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

Examples

let two = NonZeroIsize::new(2)?;
let four = NonZeroIsize::new(4)?;
let max = NonZeroIsize::new(isize::MAX)?;

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

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

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

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

该行为是未定义的

self * rhs > isize::MAX, or self * rhs < isize::MIN.

Examples

#![feature(nonzero_ops)]

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

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

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

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

Examples

let three = NonZeroIsize::new(3)?;
let twenty_seven = NonZeroIsize::new(27)?;
let half_max = NonZeroIsize::new(isize::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) -> NonZeroIsize

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

Examples

let three = NonZeroIsize::new(3)?;
let twenty_seven = NonZeroIsize::new(27)?;
let max = NonZeroIsize::new(isize::MAX)?;

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

impl NonZeroIsize

pub const MIN: NonZeroIsize = Self::new(isize::MIN).unwrap()

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

equal to isize::MIN. Note: 虽然大多数整数类型是为 MIN 和 MAX 之间的每个整数定义的，但有符号的非零整数是一种特殊情况。 他们有一个 “gap” 在 0.

Examples

assert_eq!(NonZeroIsize::MIN.get(), isize::MIN);

pub const MAX: NonZeroIsize = Self::new(isize::MAX).unwrap()

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

equal to isize::MAX. Note: 虽然大多数整数类型是为 MIN 和 MAX 之间的每个整数定义的，但有符号的非零整数是一种特殊情况。 他们有一个 “gap” 在 0.

Examples

assert_eq!(NonZeroIsize::MAX.get(), isize::MAX);

impl NonZeroIsize

pub const BITS: u32 = 64u32

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

This value is equal to isize::BITS.

Examples

assert_eq!(NonZeroIsize::BITS, isize::BITS);

Trait Implementations

impl Binary for NonZeroIsize

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

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

impl BitOr<NonZeroIsize> for NonZeroIsize

type Output = NonZeroIsize

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

fn bitor( self, rhs: NonZeroIsize ) -> <NonZeroIsize as BitOr<NonZeroIsize>>::Output

执行 | 操作。

impl BitOr<NonZeroIsize> for isize

type Output = NonZeroIsize

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

fn bitor(self, rhs: NonZeroIsize) -> <isize as BitOr<NonZeroIsize>>::Output

执行 | 操作。

impl BitOr<isize> for NonZeroIsize

type Output = NonZeroIsize

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

fn bitor(self, rhs: isize) -> <NonZeroIsize as BitOr<isize>>::Output

执行 | 操作。

impl BitOrAssign<NonZeroIsize> for NonZeroIsize

fn bitor_assign(&mut self, rhs: NonZeroIsize)

执行 |= 操作。

impl BitOrAssign<isize> for NonZeroIsize

fn bitor_assign(&mut self, rhs: isize)

执行 |= 操作。

impl Clone for NonZeroIsize

fn clone(&self) -> NonZeroIsize

返回值的副本。

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

从 source 执行复制分配。

impl Debug for NonZeroIsize

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

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

impl Display for NonZeroIsize

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

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

impl From<NonZeroI16> for NonZeroIsize

fn from(small: NonZeroI16) -> NonZeroIsize

Converts NonZeroI16 to NonZeroIsize losslessly.

impl From<NonZeroI8> for NonZeroIsize

fn from(small: NonZeroI8) -> NonZeroIsize

Converts NonZeroI8 to NonZeroIsize losslessly.

impl From<NonZeroIsize> for isize

fn from(nonzero: NonZeroIsize) -> isize

Converts a NonZeroIsize into an isize

impl From<NonZeroU8> for NonZeroIsize

fn from(small: NonZeroU8) -> NonZeroIsize

Converts NonZeroU8 to NonZeroIsize losslessly.

impl FromStr for NonZeroIsize

type Err = ParseIntError

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

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

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

impl Hash for NonZeroIsize

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

将该值输入给定的 Hasher。

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

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

impl LowerHex for NonZeroIsize

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

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

impl Neg for &NonZeroIsize

type Output = <NonZeroIsize as Neg>::Output

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

fn neg(self) -> <NonZeroIsize as Neg>::Output

执行一元 - 运算。

impl Neg for NonZeroIsize

type Output = NonZeroIsize

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

fn neg(self) -> NonZeroIsize

执行一元 - 运算。

impl Octal for NonZeroIsize

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

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

impl Ord for NonZeroIsize

fn cmp(&self, other: &NonZeroIsize) -> 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<Self>,

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

impl PartialEq<NonZeroIsize> for NonZeroIsize

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

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

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

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

impl PartialOrd<NonZeroIsize> for NonZeroIsize

fn partial_cmp(&self, other: &NonZeroIsize) -> 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 TryFrom<NonZeroI128> for NonZeroIsize

fn try_from( value: NonZeroI128 ) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroI128>>::Error>

Attempts to convert NonZeroI128 to NonZeroIsize.

type Error = TryFromIntError

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

impl TryFrom<NonZeroI32> for NonZeroIsize

fn try_from( value: NonZeroI32 ) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroI32>>::Error>

Attempts to convert NonZeroI32 to NonZeroIsize.

type Error = TryFromIntError

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

impl TryFrom<NonZeroI64> for NonZeroIsize

fn try_from( value: NonZeroI64 ) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroI64>>::Error>

Attempts to convert NonZeroI64 to NonZeroIsize.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroI128

fn try_from( value: NonZeroIsize ) -> Result<NonZeroI128, <NonZeroI128 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroI128.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroI16

fn try_from( value: NonZeroIsize ) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroI16.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroI32

fn try_from( value: NonZeroIsize ) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroI32.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroI64

fn try_from( value: NonZeroIsize ) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroI64.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroI8

fn try_from( value: NonZeroIsize ) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroI8.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroU128

fn try_from( value: NonZeroIsize ) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroU128.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroU16

fn try_from( value: NonZeroIsize ) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroU16.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroU32

fn try_from( value: NonZeroIsize ) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroU32.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroU64

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

Attempts to convert NonZeroIsize to NonZeroU64.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroU8

fn try_from( value: NonZeroIsize ) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroU8.

type Error = TryFromIntError

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

impl TryFrom<NonZeroIsize> for NonZeroUsize

fn try_from( value: NonZeroIsize ) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroUsize.

type Error = TryFromIntError

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

impl TryFrom<NonZeroU128> for NonZeroIsize

fn try_from( value: NonZeroU128 ) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroU128>>::Error>

Attempts to convert NonZeroU128 to NonZeroIsize.

type Error = TryFromIntError

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

impl TryFrom<NonZeroU16> for NonZeroIsize

fn try_from( value: NonZeroU16 ) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroU16>>::Error>

Attempts to convert NonZeroU16 to NonZeroIsize.

type Error = TryFromIntError

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

impl TryFrom<NonZeroU32> for NonZeroIsize

fn try_from( value: NonZeroU32 ) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroU32>>::Error>

Attempts to convert NonZeroU32 to NonZeroIsize.

type Error = TryFromIntError

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

impl TryFrom<NonZeroU64> for NonZeroIsize

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

Attempts to convert NonZeroU64 to NonZeroIsize.

type Error = TryFromIntError

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

impl TryFrom<NonZeroUsize> for NonZeroIsize

fn try_from( value: NonZeroUsize ) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroUsize>>::Error>

Attempts to convert NonZeroUsize to NonZeroIsize.

type Error = TryFromIntError

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

impl TryFrom<isize> for NonZeroIsize

fn try_from( value: isize ) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<isize>>::Error>

Attempts to convert isize to NonZeroIsize.

type Error = TryFromIntError

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

impl UpperHex for NonZeroIsize

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

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

impl Copy for NonZeroIsize

impl Eq for NonZeroIsize

impl StructuralEq for NonZeroIsize

impl StructuralPartialEq for NonZeroIsize