Struct core::num::NonZero

pub struct NonZero<T: ZeroablePrimitive>(/* private fields */);

🔬This is a nightly-only experimental API. (generic_nonzero #120257)

A value that is known not to equal zero.

This enables some memory layout optimization. For example, Option<NonZero<u32>> is the same size as u32:

#![feature(generic_nonzero)]
use core::mem::size_of;

assert_eq!(size_of::<Option<core::num::NonZero<u32>>>(), size_of::<u32>());

Implementations

impl NonZero<u8>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut u8) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut u8) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> u8

Returns the value as a primitive type.

pub const BITS: u32 = 8u32

The size of this non-zero integer type in bits.

This value is equal to u8::BITS.

Examples

assert_eq!(NonZeroU8::BITS, u8::BITS);

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::NonZeroU8::new(u8::MAX).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroU8::new(0b100_0000)?;
let b = NonZeroU8::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, 1.

Examples

assert_eq!(NonZeroU8::MIN.get(), 1u8);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to u8::MAX.

Examples

assert_eq!(NonZeroU8::MAX.get(), u8::MAX);

pub const fn checked_add(self, other: u8) -> Option<Self>

Adds an unsigned integer to a non-zero value. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let one = NonZeroU8::new(1)?;
let two = NonZeroU8::new(2)?;
let max = NonZeroU8::new(u8::MAX)?;

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

pub const fn saturating_add(self, other: u8) -> Self

Adds an unsigned integer to a non-zero value. Return NonZeroU8::MAX on overflow.

Examples

let one = NonZeroU8::new(1)?;
let two = NonZeroU8::new(2)?;
let max = NonZeroU8::new(u8::MAX)?;

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

pub const unsafe fn unchecked_add(self, other: u8) -> Self

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

Adds 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 > u8::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

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

let two = NonZeroU8::new(2)?;
let three = NonZeroU8::new(3)?;
let four = NonZeroU8::new(4)?;
let max = NonZeroU8::new(u8::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

Returns the base 2 logarithm of the number, rounded down.

This is the same operation as u8::ilog2, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

pub const fn ilog10(self) -> u32

Returns the base 10 logarithm of the number, rounded down.

This is the same operation as u8::ilog10, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

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

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

Calculates the middle point of self and rhs.

midpoint(a, b) is (a + b) >> 1 as if it were performed in a sufficiently-large signed integral type. This implies that the result is always rounded towards negative infinity and that no overflow will ever occur.

Examples

#![feature(num_midpoint)]

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

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

pub const fn is_power_of_two(self) -> bool

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:

let eight = std::num::NonZeroU8::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroU8::new(10).unwrap();
assert!(!ten.is_power_of_two());

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroU8::new(2)?;
let four = NonZeroU8::new(4)?;
let max = NonZeroU8::new(u8::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroU8::MAX on overflow.

Examples

let two = NonZeroU8::new(2)?;
let four = NonZeroU8::new(4)?;
let max = NonZeroU8::new(u8::MAX)?;

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

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

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

Multiplies 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 > u8::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

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

Examples

let three = NonZeroU8::new(3)?;
let twenty_seven = NonZeroU8::new(27)?;
let max = NonZeroU8::new(u8::MAX)?;

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

impl NonZero<u16>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut u16) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut u16) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> u16

Returns the value as a primitive type.

pub const BITS: u32 = 16u32

The size of this non-zero integer type in bits.

This value is equal to u16::BITS.

Examples

assert_eq!(NonZeroU16::BITS, u16::BITS);

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::NonZeroU16::new(u16::MAX).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroU16::new(0b100_0000)?;
let b = NonZeroU16::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, 1.

Examples

assert_eq!(NonZeroU16::MIN.get(), 1u16);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to u16::MAX.

Examples

assert_eq!(NonZeroU16::MAX.get(), u16::MAX);

pub const fn checked_add(self, other: u16) -> Option<Self>

Adds an unsigned integer to a non-zero value. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let one = NonZeroU16::new(1)?;
let two = NonZeroU16::new(2)?;
let max = NonZeroU16::new(u16::MAX)?;

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

pub const fn saturating_add(self, other: u16) -> Self

Adds an unsigned integer to a non-zero value. Return NonZeroU16::MAX on overflow.

Examples

let one = NonZeroU16::new(1)?;
let two = NonZeroU16::new(2)?;
let max = NonZeroU16::new(u16::MAX)?;

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

pub const unsafe fn unchecked_add(self, other: u16) -> Self

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

Adds 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 > u16::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

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

let two = NonZeroU16::new(2)?;
let three = NonZeroU16::new(3)?;
let four = NonZeroU16::new(4)?;
let max = NonZeroU16::new(u16::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

Returns the base 2 logarithm of the number, rounded down.

This is the same operation as u16::ilog2, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

pub const fn ilog10(self) -> u32

Returns the base 10 logarithm of the number, rounded down.

This is the same operation as u16::ilog10, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

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

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

Calculates the middle point of self and rhs.

midpoint(a, b) is (a + b) >> 1 as if it were performed in a sufficiently-large signed integral type. This implies that the result is always rounded towards negative infinity and that no overflow will ever occur.

Examples

#![feature(num_midpoint)]

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

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

pub const fn is_power_of_two(self) -> bool

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:

let eight = std::num::NonZeroU16::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroU16::new(10).unwrap();
assert!(!ten.is_power_of_two());

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroU16::new(2)?;
let four = NonZeroU16::new(4)?;
let max = NonZeroU16::new(u16::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroU16::MAX on overflow.

Examples

let two = NonZeroU16::new(2)?;
let four = NonZeroU16::new(4)?;
let max = NonZeroU16::new(u16::MAX)?;

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

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

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

Multiplies 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 > u16::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

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

Examples

let three = NonZeroU16::new(3)?;
let twenty_seven = NonZeroU16::new(27)?;
let max = NonZeroU16::new(u16::MAX)?;

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

impl NonZero<u32>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut u32) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut u32) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> u32

Returns the value as a primitive type.

pub const BITS: u32 = 32u32

The size of this non-zero integer type in bits.

This value is equal to u32::BITS.

Examples

assert_eq!(NonZeroU32::BITS, u32::BITS);

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::NonZeroU32::new(u32::MAX).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroU32::new(0b100_0000)?;
let b = NonZeroU32::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, 1.

Examples

assert_eq!(NonZeroU32::MIN.get(), 1u32);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to u32::MAX.

Examples

assert_eq!(NonZeroU32::MAX.get(), u32::MAX);

pub const fn checked_add(self, other: u32) -> Option<Self>

Adds an unsigned integer to a non-zero value. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let one = NonZeroU32::new(1)?;
let two = NonZeroU32::new(2)?;
let max = NonZeroU32::new(u32::MAX)?;

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

pub const fn saturating_add(self, other: u32) -> Self

Adds an unsigned integer to a non-zero value. Return NonZeroU32::MAX on overflow.

Examples

let one = NonZeroU32::new(1)?;
let two = NonZeroU32::new(2)?;
let max = NonZeroU32::new(u32::MAX)?;

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

pub const unsafe fn unchecked_add(self, other: u32) -> Self

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

Adds 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 > u32::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

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

let two = NonZeroU32::new(2)?;
let three = NonZeroU32::new(3)?;
let four = NonZeroU32::new(4)?;
let max = NonZeroU32::new(u32::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

Returns the base 2 logarithm of the number, rounded down.

This is the same operation as u32::ilog2, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

pub const fn ilog10(self) -> u32

Returns the base 10 logarithm of the number, rounded down.

This is the same operation as u32::ilog10, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

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

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

Calculates the middle point of self and rhs.

midpoint(a, b) is (a + b) >> 1 as if it were performed in a sufficiently-large signed integral type. This implies that the result is always rounded towards negative infinity and that no overflow will ever occur.

Examples

#![feature(num_midpoint)]

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

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

pub const fn is_power_of_two(self) -> bool

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:

let eight = std::num::NonZeroU32::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroU32::new(10).unwrap();
assert!(!ten.is_power_of_two());

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroU32::new(2)?;
let four = NonZeroU32::new(4)?;
let max = NonZeroU32::new(u32::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroU32::MAX on overflow.

Examples

let two = NonZeroU32::new(2)?;
let four = NonZeroU32::new(4)?;
let max = NonZeroU32::new(u32::MAX)?;

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

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

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

Multiplies 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 > u32::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

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

Examples

let three = NonZeroU32::new(3)?;
let twenty_seven = NonZeroU32::new(27)?;
let max = NonZeroU32::new(u32::MAX)?;

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

impl NonZero<u64>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut u64) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut u64) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> u64

Returns the value as a primitive type.

pub const BITS: u32 = 64u32

The size of this non-zero integer type in bits.

This value is equal to u64::BITS.

Examples

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroU64::new(0b100_0000)?;
let b = NonZeroU64::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, 1.

Examples

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

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to u64::MAX.

Examples

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

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

Adds an unsigned integer to a non-zero value. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

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

Adds an unsigned integer to a non-zero value. Return NonZeroU64::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) -> Self

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

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

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

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

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

Returns the base 2 logarithm of the number, rounded down.

This is the same operation as u64::ilog2, except that it has no failure cases to worry about since this value can never be zero.

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

Returns the base 10 logarithm of the number, rounded down.

This is the same operation as u64::ilog10, except that it has no failure cases to worry about since this value can never be zero.

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)

Calculates the middle point of self and rhs.

midpoint(a, b) is (a + b) >> 1 as if it were performed in a sufficiently-large signed integral type. This implies that the result is always rounded towards negative infinity and that no overflow will ever occur.

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

pub const fn is_power_of_two(self) -> bool

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:

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

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

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: Self) -> Self

Multiplies two non-zero integers together. Return NonZeroU64::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: Self) -> Self

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

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

Raise non-zero value to an integer power. Return NonZeroU64::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 NonZero<u128>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut u128) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut u128) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> u128

Returns the value as a primitive type.

pub const BITS: u32 = 128u32

The size of this non-zero integer type in bits.

This value is equal to u128::BITS.

Examples

assert_eq!(NonZeroU128::BITS, u128::BITS);

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::NonZeroU128::new(u128::MAX).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroU128::new(0b100_0000)?;
let b = NonZeroU128::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, 1.

Examples

assert_eq!(NonZeroU128::MIN.get(), 1u128);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to u128::MAX.

Examples

assert_eq!(NonZeroU128::MAX.get(), u128::MAX);

pub const fn checked_add(self, other: u128) -> Option<Self>

Adds an unsigned integer to a non-zero value. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let one = NonZeroU128::new(1)?;
let two = NonZeroU128::new(2)?;
let max = NonZeroU128::new(u128::MAX)?;

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

pub const fn saturating_add(self, other: u128) -> Self

Adds an unsigned integer to a non-zero value. Return NonZeroU128::MAX on overflow.

Examples

let one = NonZeroU128::new(1)?;
let two = NonZeroU128::new(2)?;
let max = NonZeroU128::new(u128::MAX)?;

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

pub const unsafe fn unchecked_add(self, other: u128) -> Self

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

Adds 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 > u128::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

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

let two = NonZeroU128::new(2)?;
let three = NonZeroU128::new(3)?;
let four = NonZeroU128::new(4)?;
let max = NonZeroU128::new(u128::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

Returns the base 2 logarithm of the number, rounded down.

This is the same operation as u128::ilog2, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

pub const fn ilog10(self) -> u32

Returns the base 10 logarithm of the number, rounded down.

This is the same operation as u128::ilog10, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

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

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

Calculates the middle point of self and rhs.

midpoint(a, b) is (a + b) >> 1 as if it were performed in a sufficiently-large signed integral type. This implies that the result is always rounded towards negative infinity and that no overflow will ever occur.

Examples

#![feature(num_midpoint)]

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

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

pub const fn is_power_of_two(self) -> bool

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:

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

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroU128::new(2)?;
let four = NonZeroU128::new(4)?;
let max = NonZeroU128::new(u128::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroU128::MAX on overflow.

Examples

let two = NonZeroU128::new(2)?;
let four = NonZeroU128::new(4)?;
let max = NonZeroU128::new(u128::MAX)?;

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

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

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

Multiplies 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 > u128::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

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

Examples

let three = NonZeroU128::new(3)?;
let twenty_seven = NonZeroU128::new(27)?;
let max = NonZeroU128::new(u128::MAX)?;

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

impl NonZero<usize>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut usize) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut usize) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> usize

Returns the value as a primitive type.

pub const BITS: u32 = 64u32

The size of this non-zero integer type in bits.

This value is equal to usize::BITS.

Examples

assert_eq!(NonZeroUsize::BITS, usize::BITS);

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::NonZeroUsize::new(usize::MAX).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroUsize::new(0b100_0000)?;
let b = NonZeroUsize::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, 1.

Examples

assert_eq!(NonZeroUsize::MIN.get(), 1usize);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to usize::MAX.

Examples

assert_eq!(NonZeroUsize::MAX.get(), usize::MAX);

pub const fn checked_add(self, other: usize) -> Option<Self>

Adds an unsigned integer to a non-zero value. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let one = NonZeroUsize::new(1)?;
let two = NonZeroUsize::new(2)?;
let max = NonZeroUsize::new(usize::MAX)?;

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

pub const fn saturating_add(self, other: usize) -> Self

Adds an unsigned integer to a non-zero value. Return NonZeroUsize::MAX on overflow.

Examples

let one = NonZeroUsize::new(1)?;
let two = NonZeroUsize::new(2)?;
let max = NonZeroUsize::new(usize::MAX)?;

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

pub const unsafe fn unchecked_add(self, other: usize) -> Self

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

Adds 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 > usize::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

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

let two = NonZeroUsize::new(2)?;
let three = NonZeroUsize::new(3)?;
let four = NonZeroUsize::new(4)?;
let max = NonZeroUsize::new(usize::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

Returns the base 2 logarithm of the number, rounded down.

This is the same operation as usize::ilog2, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

pub const fn ilog10(self) -> u32

Returns the base 10 logarithm of the number, rounded down.

This is the same operation as usize::ilog10, except that it has no failure cases to worry about since this value can never be zero.

Examples

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

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

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

Calculates the middle point of self and rhs.

midpoint(a, b) is (a + b) >> 1 as if it were performed in a sufficiently-large signed integral type. This implies that the result is always rounded towards negative infinity and that no overflow will ever occur.

Examples

#![feature(num_midpoint)]

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

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

pub const fn is_power_of_two(self) -> bool

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:

let eight = std::num::NonZeroUsize::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroUsize::new(10).unwrap();
assert!(!ten.is_power_of_two());

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroUsize::new(2)?;
let four = NonZeroUsize::new(4)?;
let max = NonZeroUsize::new(usize::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroUsize::MAX on overflow.

Examples

let two = NonZeroUsize::new(2)?;
let four = NonZeroUsize::new(4)?;
let max = NonZeroUsize::new(usize::MAX)?;

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

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

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

Multiplies 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 > usize::MAX.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

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

Examples

let three = NonZeroUsize::new(3)?;
let twenty_seven = NonZeroUsize::new(27)?;
let max = NonZeroUsize::new(usize::MAX)?;

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

impl NonZero<i8>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut i8) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut i8) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> i8

Returns the value as a primitive type.

pub const BITS: u32 = 8u32

The size of this non-zero integer type in bits.

This value is equal to i8::BITS.

Examples

assert_eq!(NonZeroI8::BITS, i8::BITS);

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::NonZeroI8::new(-1i8).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroI8::new(0b100_0000)?;
let b = NonZeroI8::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, equal to i8::MIN.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI8::MIN.get(), i8::MIN);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to i8::MAX.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI8::MAX.get(), i8::MAX);

pub const fn abs(self) -> Self

Computes the absolute value of self. See i8::abs for documentation on overflow behaviour.

Example

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

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

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

Checked absolute value. Checks for overflow and returns None if self == NonZeroI8::MIN. The result cannot be zero.

Example

let pos = NonZeroI8::new(1)?;
let neg = NonZeroI8::new(-1)?;
let min = NonZeroI8::new(i8::MIN)?;

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

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

Computes the absolute value of self, with overflow information, see i8::overflowing_abs.

Example

let pos = NonZeroI8::new(1)?;
let neg = NonZeroI8::new(-1)?;
let min = NonZeroI8::new(i8::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) -> Self

Saturating absolute value, see i8::saturating_abs.

Example

let pos = NonZeroI8::new(1)?;
let neg = NonZeroI8::new(-1)?;
let min = NonZeroI8::new(i8::MIN)?;
let min_plus = NonZeroI8::new(i8::MIN + 1)?;
let max = NonZeroI8::new(i8::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) -> Self

Wrapping absolute value, see i8::wrapping_abs.

Example

let pos = NonZeroI8::new(1)?;
let neg = NonZeroI8::new(-1)?;
let min = NonZeroI8::new(i8::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) -> NonZeroU8

Computes the absolute value of self without any wrapping or panicking.

Example

let u_pos = NonZeroU8::new(1)?;
let i_pos = NonZeroI8::new(1)?;
let i_neg = NonZeroI8::new(-1)?;
let i_min = NonZeroI8::new(i8::MIN)?;
let u_max = NonZeroU8::new(u8::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

Returns true if self is positive and false if the number is negative.

Example

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

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

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is positive.

Example

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

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

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

Checked negation. Computes -self, returning None if self == NonZeroI8::MIN.

Example

let pos_five = NonZeroI8::new(5)?;
let neg_five = NonZeroI8::new(-5)?;
let min = NonZeroI8::new(i8::MIN)?;

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

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

Negates self, overflowing if this is equal to the minimum value.

See i8::overflowing_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI8::new(5)?;
let neg_five = NonZeroI8::new(-5)?;
let min = NonZeroI8::new(i8::MIN)?;

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

pub const fn saturating_neg(self) -> Self

Saturating negation. Computes -self, returning NonZeroI8::MAX if self == NonZeroI8::MIN instead of overflowing.

Example

let pos_five = NonZeroI8::new(5)?;
let neg_five = NonZeroI8::new(-5)?;
let min = NonZeroI8::new(i8::MIN)?;
let min_plus_one = NonZeroI8::new(i8::MIN + 1)?;
let max = NonZeroI8::new(i8::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) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

See i8::wrapping_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI8::new(5)?;
let neg_five = NonZeroI8::new(-5)?;
let min = NonZeroI8::new(i8::MIN)?;

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

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroI8::new(2)?;
let four = NonZeroI8::new(4)?;
let max = NonZeroI8::new(i8::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroI8::MAX on overflow.

Examples

let two = NonZeroI8::new(2)?;
let four = NonZeroI8::new(4)?;
let max = NonZeroI8::new(i8::MAX)?;

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

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

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

Multiplies 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 > i8::MAX, or self * rhs < i8::MIN.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

Raise non-zero value to an integer power. Return NonZeroI8::MIN or NonZeroI8::MAX on overflow.

Examples

let three = NonZeroI8::new(3)?;
let twenty_seven = NonZeroI8::new(27)?;
let max = NonZeroI8::new(i8::MAX)?;

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

impl NonZero<i16>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut i16) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut i16) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> i16

Returns the value as a primitive type.

pub const BITS: u32 = 16u32

The size of this non-zero integer type in bits.

This value is equal to i16::BITS.

Examples

assert_eq!(NonZeroI16::BITS, i16::BITS);

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::NonZeroI16::new(-1i16).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroI16::new(0b100_0000)?;
let b = NonZeroI16::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, equal to i16::MIN.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI16::MIN.get(), i16::MIN);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to i16::MAX.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI16::MAX.get(), i16::MAX);

pub const fn abs(self) -> Self

Computes the absolute value of self. See i16::abs for documentation on overflow behaviour.

Example

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

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

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

Checked absolute value. Checks for overflow and returns None if self == NonZeroI16::MIN. The result cannot be zero.

Example

let pos = NonZeroI16::new(1)?;
let neg = NonZeroI16::new(-1)?;
let min = NonZeroI16::new(i16::MIN)?;

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

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

Computes the absolute value of self, with overflow information, see i16::overflowing_abs.

Example

let pos = NonZeroI16::new(1)?;
let neg = NonZeroI16::new(-1)?;
let min = NonZeroI16::new(i16::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) -> Self

Saturating absolute value, see i16::saturating_abs.

Example

let pos = NonZeroI16::new(1)?;
let neg = NonZeroI16::new(-1)?;
let min = NonZeroI16::new(i16::MIN)?;
let min_plus = NonZeroI16::new(i16::MIN + 1)?;
let max = NonZeroI16::new(i16::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) -> Self

Wrapping absolute value, see i16::wrapping_abs.

Example

let pos = NonZeroI16::new(1)?;
let neg = NonZeroI16::new(-1)?;
let min = NonZeroI16::new(i16::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) -> NonZeroU16

Computes the absolute value of self without any wrapping or panicking.

Example

let u_pos = NonZeroU16::new(1)?;
let i_pos = NonZeroI16::new(1)?;
let i_neg = NonZeroI16::new(-1)?;
let i_min = NonZeroI16::new(i16::MIN)?;
let u_max = NonZeroU16::new(u16::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

Returns true if self is positive and false if the number is negative.

Example

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

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

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is positive.

Example

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

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

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

Checked negation. Computes -self, returning None if self == NonZeroI16::MIN.

Example

let pos_five = NonZeroI16::new(5)?;
let neg_five = NonZeroI16::new(-5)?;
let min = NonZeroI16::new(i16::MIN)?;

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

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

Negates self, overflowing if this is equal to the minimum value.

See i16::overflowing_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI16::new(5)?;
let neg_five = NonZeroI16::new(-5)?;
let min = NonZeroI16::new(i16::MIN)?;

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

pub const fn saturating_neg(self) -> Self

Saturating negation. Computes -self, returning NonZeroI16::MAX if self == NonZeroI16::MIN instead of overflowing.

Example

let pos_five = NonZeroI16::new(5)?;
let neg_five = NonZeroI16::new(-5)?;
let min = NonZeroI16::new(i16::MIN)?;
let min_plus_one = NonZeroI16::new(i16::MIN + 1)?;
let max = NonZeroI16::new(i16::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) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

See i16::wrapping_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI16::new(5)?;
let neg_five = NonZeroI16::new(-5)?;
let min = NonZeroI16::new(i16::MIN)?;

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

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroI16::new(2)?;
let four = NonZeroI16::new(4)?;
let max = NonZeroI16::new(i16::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroI16::MAX on overflow.

Examples

let two = NonZeroI16::new(2)?;
let four = NonZeroI16::new(4)?;
let max = NonZeroI16::new(i16::MAX)?;

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

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

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

Multiplies 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 > i16::MAX, or self * rhs < i16::MIN.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

Raise non-zero value to an integer power. Return NonZeroI16::MIN or NonZeroI16::MAX on overflow.

Examples

let three = NonZeroI16::new(3)?;
let twenty_seven = NonZeroI16::new(27)?;
let max = NonZeroI16::new(i16::MAX)?;

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

impl NonZero<i32>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut i32) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut i32) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> i32

Returns the value as a primitive type.

pub const BITS: u32 = 32u32

The size of this non-zero integer type in bits.

This value is equal to i32::BITS.

Examples

assert_eq!(NonZeroI32::BITS, i32::BITS);

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::NonZeroI32::new(-1i32).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroI32::new(0b100_0000)?;
let b = NonZeroI32::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, equal to i32::MIN.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI32::MIN.get(), i32::MIN);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to i32::MAX.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI32::MAX.get(), i32::MAX);

pub const fn abs(self) -> Self

Computes the absolute value of self. See i32::abs for documentation on overflow behaviour.

Example

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

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

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

Checked absolute value. Checks for overflow and returns None if self == NonZeroI32::MIN. The result cannot be zero.

Example

let pos = NonZeroI32::new(1)?;
let neg = NonZeroI32::new(-1)?;
let min = NonZeroI32::new(i32::MIN)?;

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

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

Computes the absolute value of self, with overflow information, see i32::overflowing_abs.

Example

let pos = NonZeroI32::new(1)?;
let neg = NonZeroI32::new(-1)?;
let min = NonZeroI32::new(i32::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) -> Self

Saturating absolute value, see i32::saturating_abs.

Example

let pos = NonZeroI32::new(1)?;
let neg = NonZeroI32::new(-1)?;
let min = NonZeroI32::new(i32::MIN)?;
let min_plus = NonZeroI32::new(i32::MIN + 1)?;
let max = NonZeroI32::new(i32::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) -> Self

Wrapping absolute value, see i32::wrapping_abs.

Example

let pos = NonZeroI32::new(1)?;
let neg = NonZeroI32::new(-1)?;
let min = NonZeroI32::new(i32::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) -> NonZeroU32

Computes the absolute value of self without any wrapping or panicking.

Example

let u_pos = NonZeroU32::new(1)?;
let i_pos = NonZeroI32::new(1)?;
let i_neg = NonZeroI32::new(-1)?;
let i_min = NonZeroI32::new(i32::MIN)?;
let u_max = NonZeroU32::new(u32::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

Returns true if self is positive and false if the number is negative.

Example

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

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

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is positive.

Example

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

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

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

Checked negation. Computes -self, returning None if self == NonZeroI32::MIN.

Example

let pos_five = NonZeroI32::new(5)?;
let neg_five = NonZeroI32::new(-5)?;
let min = NonZeroI32::new(i32::MIN)?;

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

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

Negates self, overflowing if this is equal to the minimum value.

See i32::overflowing_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI32::new(5)?;
let neg_five = NonZeroI32::new(-5)?;
let min = NonZeroI32::new(i32::MIN)?;

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

pub const fn saturating_neg(self) -> Self

Saturating negation. Computes -self, returning NonZeroI32::MAX if self == NonZeroI32::MIN instead of overflowing.

Example

let pos_five = NonZeroI32::new(5)?;
let neg_five = NonZeroI32::new(-5)?;
let min = NonZeroI32::new(i32::MIN)?;
let min_plus_one = NonZeroI32::new(i32::MIN + 1)?;
let max = NonZeroI32::new(i32::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) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

See i32::wrapping_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI32::new(5)?;
let neg_five = NonZeroI32::new(-5)?;
let min = NonZeroI32::new(i32::MIN)?;

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

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroI32::new(2)?;
let four = NonZeroI32::new(4)?;
let max = NonZeroI32::new(i32::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroI32::MAX on overflow.

Examples

let two = NonZeroI32::new(2)?;
let four = NonZeroI32::new(4)?;
let max = NonZeroI32::new(i32::MAX)?;

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

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

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

Multiplies 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 > i32::MAX, or self * rhs < i32::MIN.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

Raise non-zero value to an integer power. Return NonZeroI32::MIN or NonZeroI32::MAX on overflow.

Examples

let three = NonZeroI32::new(3)?;
let twenty_seven = NonZeroI32::new(27)?;
let max = NonZeroI32::new(i32::MAX)?;

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

impl NonZero<i64>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut i64) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut i64) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> i64

Returns the value as a primitive type.

pub const BITS: u32 = 64u32

The size of this non-zero integer type in bits.

This value is equal to i64::BITS.

Examples

assert_eq!(NonZeroI64::BITS, i64::BITS);

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::NonZeroI64::new(-1i64).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroI64::new(0b100_0000)?;
let b = NonZeroI64::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, equal to i64::MIN.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI64::MIN.get(), i64::MIN);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to i64::MAX.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI64::MAX.get(), i64::MAX);

pub const fn abs(self) -> Self

Computes the absolute value of self. See i64::abs for documentation on overflow behaviour.

Example

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

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

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

Checked absolute value. Checks for overflow and returns None if self == NonZeroI64::MIN. The result cannot be zero.

Example

let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::MIN)?;

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

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

Computes the absolute value of self, with overflow information, see i64::overflowing_abs.

Example

let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::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) -> Self

Saturating absolute value, see i64::saturating_abs.

Example

let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::MIN)?;
let min_plus = NonZeroI64::new(i64::MIN + 1)?;
let max = NonZeroI64::new(i64::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) -> Self

Wrapping absolute value, see i64::wrapping_abs.

Example

let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::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) -> NonZeroU64

Computes the absolute value of self without any wrapping or panicking.

Example

let u_pos = NonZeroU64::new(1)?;
let i_pos = NonZeroI64::new(1)?;
let i_neg = NonZeroI64::new(-1)?;
let i_min = NonZeroI64::new(i64::MIN)?;
let u_max = NonZeroU64::new(u64::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

Returns true if self is positive and false if the number is negative.

Example

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

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

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is positive.

Example

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

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

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

Checked negation. Computes -self, returning None if self == NonZeroI64::MIN.

Example

let pos_five = NonZeroI64::new(5)?;
let neg_five = NonZeroI64::new(-5)?;
let min = NonZeroI64::new(i64::MIN)?;

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

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

Negates self, overflowing if this is equal to the minimum value.

See i64::overflowing_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI64::new(5)?;
let neg_five = NonZeroI64::new(-5)?;
let min = NonZeroI64::new(i64::MIN)?;

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

pub const fn saturating_neg(self) -> Self

Saturating negation. Computes -self, returning NonZeroI64::MAX if self == NonZeroI64::MIN instead of overflowing.

Example

let pos_five = NonZeroI64::new(5)?;
let neg_five = NonZeroI64::new(-5)?;
let min = NonZeroI64::new(i64::MIN)?;
let min_plus_one = NonZeroI64::new(i64::MIN + 1)?;
let max = NonZeroI64::new(i64::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) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

See i64::wrapping_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI64::new(5)?;
let neg_five = NonZeroI64::new(-5)?;
let min = NonZeroI64::new(i64::MIN)?;

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

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroI64::new(2)?;
let four = NonZeroI64::new(4)?;
let max = NonZeroI64::new(i64::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroI64::MAX on overflow.

Examples

let two = NonZeroI64::new(2)?;
let four = NonZeroI64::new(4)?;
let max = NonZeroI64::new(i64::MAX)?;

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

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

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

Multiplies 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 > i64::MAX, or self * rhs < i64::MIN.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

Raise non-zero value to an integer power. Return NonZeroI64::MIN or NonZeroI64::MAX on overflow.

Examples

let three = NonZeroI64::new(3)?;
let twenty_seven = NonZeroI64::new(27)?;
let max = NonZeroI64::new(i64::MAX)?;

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

impl NonZero<i128>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut i128) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut i128) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> i128

Returns the value as a primitive type.

pub const BITS: u32 = 128u32

The size of this non-zero integer type in bits.

This value is equal to i128::BITS.

Examples

assert_eq!(NonZeroI128::BITS, i128::BITS);

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::NonZeroI128::new(-1i128).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroI128::new(0b100_0000)?;
let b = NonZeroI128::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, equal to i128::MIN.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI128::MIN.get(), i128::MIN);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to i128::MAX.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

assert_eq!(NonZeroI128::MAX.get(), i128::MAX);

pub const fn abs(self) -> Self

Computes the absolute value of self. See i128::abs for documentation on overflow behaviour.

Example

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

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

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

Checked absolute value. Checks for overflow and returns None if self == NonZeroI128::MIN. The result cannot be zero.

Example

let pos = NonZeroI128::new(1)?;
let neg = NonZeroI128::new(-1)?;
let min = NonZeroI128::new(i128::MIN)?;

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

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

Computes the absolute value of self, with overflow information, see i128::overflowing_abs.

Example

let pos = NonZeroI128::new(1)?;
let neg = NonZeroI128::new(-1)?;
let min = NonZeroI128::new(i128::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) -> Self

Saturating absolute value, see i128::saturating_abs.

Example

let pos = NonZeroI128::new(1)?;
let neg = NonZeroI128::new(-1)?;
let min = NonZeroI128::new(i128::MIN)?;
let min_plus = NonZeroI128::new(i128::MIN + 1)?;
let max = NonZeroI128::new(i128::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) -> Self

Wrapping absolute value, see i128::wrapping_abs.

Example

let pos = NonZeroI128::new(1)?;
let neg = NonZeroI128::new(-1)?;
let min = NonZeroI128::new(i128::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) -> NonZeroU128

Computes the absolute value of self without any wrapping or panicking.

Example

let u_pos = NonZeroU128::new(1)?;
let i_pos = NonZeroI128::new(1)?;
let i_neg = NonZeroI128::new(-1)?;
let i_min = NonZeroI128::new(i128::MIN)?;
let u_max = NonZeroU128::new(u128::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

Returns true if self is positive and false if the number is negative.

Example

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

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

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is positive.

Example

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

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

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

Checked negation. Computes -self, returning None if self == NonZeroI128::MIN.

Example

let pos_five = NonZeroI128::new(5)?;
let neg_five = NonZeroI128::new(-5)?;
let min = NonZeroI128::new(i128::MIN)?;

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

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

Negates self, overflowing if this is equal to the minimum value.

See i128::overflowing_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI128::new(5)?;
let neg_five = NonZeroI128::new(-5)?;
let min = NonZeroI128::new(i128::MIN)?;

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

pub const fn saturating_neg(self) -> Self

Saturating negation. Computes -self, returning NonZeroI128::MAX if self == NonZeroI128::MIN instead of overflowing.

Example

let pos_five = NonZeroI128::new(5)?;
let neg_five = NonZeroI128::new(-5)?;
let min = NonZeroI128::new(i128::MIN)?;
let min_plus_one = NonZeroI128::new(i128::MIN + 1)?;
let max = NonZeroI128::new(i128::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) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

See i128::wrapping_neg for documentation on overflow behaviour.

Example

let pos_five = NonZeroI128::new(5)?;
let neg_five = NonZeroI128::new(-5)?;
let min = NonZeroI128::new(i128::MIN)?;

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

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

let two = NonZeroI128::new(2)?;
let four = NonZeroI128::new(4)?;
let max = NonZeroI128::new(i128::MAX)?;

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

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

Multiplies two non-zero integers together. Return NonZeroI128::MAX on overflow.

Examples

let two = NonZeroI128::new(2)?;
let four = NonZeroI128::new(4)?;
let max = NonZeroI128::new(i128::MAX)?;

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

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

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

Multiplies 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 > i128::MAX, or self * rhs < i128::MIN.

Examples

#![feature(nonzero_ops)]

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

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

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

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples

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

Raise non-zero value to an integer power. Return NonZeroI128::MIN or NonZeroI128::MAX on overflow.

Examples

let three = NonZeroI128::new(3)?;
let twenty_seven = NonZeroI128::new(27)?;
let max = NonZeroI128::new(i128::MAX)?;

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

impl NonZero<isize>

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

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.

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

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

pub unsafe fn from_mut_unchecked(n: &mut isize) -> &mut Self

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if *n is zero.

Safety

The referenced value must not be currently zero.

pub fn from_mut(n: &mut isize) -> Option<&mut Self>

🔬This is a nightly-only experimental API. (nonzero_from_mut #106290)

Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.

pub const fn get(self) -> isize

Returns the value as a primitive type.

pub const BITS: u32 = 64u32

The size of this non-zero integer type in bits.

This value is equal to isize::BITS.

Examples

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

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::NonZeroIsize::new(-1isize).unwrap();

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

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

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

pub fn count_ones(self) -> NonZeroU32

🔬This is a nightly-only experimental API. (non_zero_count_ones #120287)

Returns the number of ones in the binary representation of self.

Examples

Basic usage:

#![feature(non_zero_count_ones)]

let one = num::NonZeroU32::new(1)?;
let three = num::NonZeroU32::new(3)?;
let a = NonZeroIsize::new(0b100_0000)?;
let b = NonZeroIsize::new(0b100_0011)?;

assert_eq!(a.count_ones(), one);
assert_eq!(b.count_ones(), three);

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, equal to isize::MIN.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

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

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to isize::MAX.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples

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

pub const fn abs(self) -> Self

Computes the absolute value of self. See isize::abs for documentation on overflow behaviour.

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<Self>

Checked absolute value. Checks for overflow and returns None if self == NonZeroIsize::MIN. The result cannot be zero.

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) -> (Self, bool)

Computes the absolute value of self, with overflow information, see 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) -> Self

Saturating absolute value, see 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) -> Self

Wrapping absolute value, see 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

Computes the absolute value of self without any wrapping or panicking.

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

Returns true if self is positive and false if the number is negative.

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

Returns true if self is negative and false if the number is positive.

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<Self>

Checked negation. Computes -self, returning None if self == NonZeroIsize::MIN.

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) -> (Self, bool)

Negates self, overflowing if this is equal to the minimum value.

See isize::overflowing_neg for documentation on overflow behaviour.

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

Saturating negation. Computes -self, returning NonZeroIsize::MAX if self == NonZeroIsize::MIN instead of overflowing.

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

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

See isize::wrapping_neg for documentation on overflow behaviour.

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

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

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

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: Self) -> Self

Multiplies two non-zero integers together. Return NonZeroIsize::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: Self) -> Self

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

Multiplies 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 > 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<Self>

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

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

Raise non-zero value to an integer power. Return NonZeroIsize::MIN or NonZeroIsize::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));

Trait Implementations

impl BitOr<NonZero<i128>> for i128

type Output = NonZero<i128>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<i16>> for i16

type Output = NonZero<i16>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<i32>> for i32

type Output = NonZero<i32>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<i64>> for i64

type Output = NonZero<i64>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<i8>> for i8

type Output = NonZero<i8>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<isize>> for isize

type Output = NonZero<isize>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<u128>> for u128

type Output = NonZero<u128>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<u16>> for u16

type Output = NonZero<u16>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<u32>> for u32

type Output = NonZero<u32>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<u64>> for u64

type Output = NonZero<u64>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<u8>> for u8

type Output = NonZero<u8>

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZero<usize>> for usize

type Output = NonZero<usize>

The resulting type after applying the | operator.

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

Performs the | operation.

impl Div<NonZero<u128>> for u128

fn div(self, other: NonZeroU128) -> u128

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

type Output = u128

The resulting type after applying the / operator.

impl Div<NonZero<u16>> for u16

fn div(self, other: NonZeroU16) -> u16

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

type Output = u16

The resulting type after applying the / operator.

impl Div<NonZero<u32>> for u32

fn div(self, other: NonZeroU32) -> u32

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

type Output = u32

The resulting type after applying the / operator.

impl Div<NonZero<u64>> for u64

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.

impl Div<NonZero<u8>> for u8

fn div(self, other: NonZeroU8) -> u8

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

type Output = u8

The resulting type after applying the / operator.

impl Div<NonZero<usize>> for usize

fn div(self, other: NonZeroUsize) -> usize

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

type Output = usize

The resulting type after applying the / operator.

impl From<NonZero<i128>> for i128

fn from(nonzero: NonZeroI128) -> Self

Converts a NonZeroI128 into an i128

impl From<NonZero<i16>> for NonZeroI128

fn from(small: NonZeroI16) -> Self

Converts NonZeroI16 to NonZeroI128 losslessly.

impl From<NonZero<i16>> for NonZeroI32

fn from(small: NonZeroI16) -> Self

Converts NonZeroI16 to NonZeroI32 losslessly.

impl From<NonZero<i16>> for NonZeroI64

fn from(small: NonZeroI16) -> Self

Converts NonZeroI16 to NonZeroI64 losslessly.

impl From<NonZero<i16>> for NonZeroIsize

fn from(small: NonZeroI16) -> Self

Converts NonZeroI16 to NonZeroIsize losslessly.

impl From<NonZero<i16>> for i16

fn from(nonzero: NonZeroI16) -> Self

Converts a NonZeroI16 into an i16

impl From<NonZero<i32>> for NonZeroI128

fn from(small: NonZeroI32) -> Self

Converts NonZeroI32 to NonZeroI128 losslessly.

impl From<NonZero<i32>> for NonZeroI64

fn from(small: NonZeroI32) -> Self

Converts NonZeroI32 to NonZeroI64 losslessly.

impl From<NonZero<i32>> for i32

fn from(nonzero: NonZeroI32) -> Self

Converts a NonZeroI32 into an i32

impl From<NonZero<i64>> for NonZeroI128

fn from(small: NonZeroI64) -> Self

Converts NonZeroI64 to NonZeroI128 losslessly.

impl From<NonZero<i64>> for i64

fn from(nonzero: NonZeroI64) -> Self

Converts a NonZeroI64 into an i64

impl From<NonZero<i8>> for NonZeroI128

fn from(small: NonZeroI8) -> Self

Converts NonZeroI8 to NonZeroI128 losslessly.

impl From<NonZero<i8>> for NonZeroI16

fn from(small: NonZeroI8) -> Self

Converts NonZeroI8 to NonZeroI16 losslessly.

impl From<NonZero<i8>> for NonZeroI32

fn from(small: NonZeroI8) -> Self

Converts NonZeroI8 to NonZeroI32 losslessly.

impl From<NonZero<i8>> for NonZeroI64

fn from(small: NonZeroI8) -> Self

Converts NonZeroI8 to NonZeroI64 losslessly.

impl From<NonZero<i8>> for NonZeroIsize

fn from(small: NonZeroI8) -> Self

Converts NonZeroI8 to NonZeroIsize losslessly.

impl From<NonZero<i8>> for i8

fn from(nonzero: NonZeroI8) -> Self

Converts a NonZeroI8 into an i8

impl From<NonZero<isize>> for isize

fn from(nonzero: NonZeroIsize) -> Self

Converts a NonZeroIsize into an isize

impl From<NonZero<u128>> for u128

fn from(nonzero: NonZeroU128) -> Self

Converts a NonZeroU128 into an u128

impl From<NonZero<u16>> for NonZeroI128

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroI128 losslessly.

impl From<NonZero<u16>> for NonZeroI32

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroI32 losslessly.

impl From<NonZero<u16>> for NonZeroI64

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroI64 losslessly.

impl From<NonZero<u16>> for NonZeroU128

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroU128 losslessly.

impl From<NonZero<u16>> for NonZeroU32

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroU32 losslessly.

impl From<NonZero<u16>> for NonZeroU64

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroU64 losslessly.

impl From<NonZero<u16>> for NonZeroUsize

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroUsize losslessly.

impl From<NonZero<u16>> for u16

fn from(nonzero: NonZeroU16) -> Self

Converts a NonZeroU16 into an u16

impl From<NonZero<u32>> for NonZeroI128

fn from(small: NonZeroU32) -> Self

Converts NonZeroU32 to NonZeroI128 losslessly.

impl From<NonZero<u32>> for NonZeroI64

fn from(small: NonZeroU32) -> Self

Converts NonZeroU32 to NonZeroI64 losslessly.

impl From<NonZero<u32>> for NonZeroU128

fn from(small: NonZeroU32) -> Self

Converts NonZeroU32 to NonZeroU128 losslessly.

impl From<NonZero<u32>> for NonZeroU64

fn from(small: NonZeroU32) -> Self

Converts NonZeroU32 to NonZeroU64 losslessly.

impl From<NonZero<u32>> for u32

fn from(nonzero: NonZeroU32) -> Self

Converts a NonZeroU32 into an u32

impl From<NonZero<u64>> for NonZeroI128

fn from(small: NonZeroU64) -> Self

Converts NonZeroU64 to NonZeroI128 losslessly.

impl From<NonZero<u64>> for NonZeroU128

fn from(small: NonZeroU64) -> Self

Converts NonZeroU64 to NonZeroU128 losslessly.

impl From<NonZero<u64>> for u64

fn from(nonzero: NonZeroU64) -> Self

Converts a NonZeroU64 into an u64

impl From<NonZero<u8>> for NonZeroI128

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroI128 losslessly.

impl From<NonZero<u8>> for NonZeroI16

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroI16 losslessly.

impl From<NonZero<u8>> for NonZeroI32

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroI32 losslessly.

impl From<NonZero<u8>> for NonZeroI64

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroI64 losslessly.

impl From<NonZero<u8>> for NonZeroIsize

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroIsize losslessly.

impl From<NonZero<u8>> for NonZeroU128

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroU128 losslessly.

impl From<NonZero<u8>> for NonZeroU16

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroU16 losslessly.

impl From<NonZero<u8>> for NonZeroU32

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroU32 losslessly.

impl From<NonZero<u8>> for NonZeroU64

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroU64 losslessly.

impl From<NonZero<u8>> for NonZeroUsize

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroUsize losslessly.

impl From<NonZero<u8>> for u8

fn from(nonzero: NonZeroU8) -> Self

Converts a NonZeroU8 into an u8

impl From<NonZero<usize>> for usize

fn from(nonzero: NonZeroUsize) -> Self

Converts a NonZeroUsize into an usize

impl Rem<NonZero<u128>> for u128

fn rem(self, other: NonZeroU128) -> u128

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

type Output = u128

The resulting type after applying the % operator.

impl Rem<NonZero<u16>> for u16

fn rem(self, other: NonZeroU16) -> u16

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

type Output = u16

The resulting type after applying the % operator.

impl Rem<NonZero<u32>> for u32

fn rem(self, other: NonZeroU32) -> u32

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

type Output = u32

The resulting type after applying the % operator.

impl Rem<NonZero<u64>> for u64

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.

impl Rem<NonZero<u8>> for u8

fn rem(self, other: NonZeroU8) -> u8

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

type Output = u8

The resulting type after applying the % operator.

impl Rem<NonZero<usize>> for usize

fn rem(self, other: NonZeroUsize) -> usize

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

type Output = usize

The resulting type after applying the % operator.

impl TryFrom<NonZero<i128>> for NonZeroI16

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

Attempts to convert NonZeroI128 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroI32

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

Attempts to convert NonZeroI128 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroI64

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

Attempts to convert NonZeroI128 to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroI8

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

Attempts to convert NonZeroI128 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroIsize

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

Attempts to convert NonZeroI128 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroU128

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

Attempts to convert NonZeroI128 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroU16

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

Attempts to convert NonZeroI128 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroU32

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

Attempts to convert NonZeroI128 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroU64

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

Attempts to convert NonZeroI128 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroU8

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

Attempts to convert NonZeroI128 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i128>> for NonZeroUsize

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

Attempts to convert NonZeroI128 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i16>> for NonZeroI8

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

Attempts to convert NonZeroI16 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i16>> for NonZeroU128

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

Attempts to convert NonZeroI16 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i16>> for NonZeroU16

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

Attempts to convert NonZeroI16 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i16>> for NonZeroU32

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

Attempts to convert NonZeroI16 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i16>> for NonZeroU64

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

Attempts to convert NonZeroI16 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i16>> for NonZeroU8

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

Attempts to convert NonZeroI16 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i16>> for NonZeroUsize

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

Attempts to convert NonZeroI16 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i32>> for NonZeroI16

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

Attempts to convert NonZeroI32 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i32>> for NonZeroI8

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

Attempts to convert NonZeroI32 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i32>> for NonZeroIsize

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

Attempts to convert NonZeroI32 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i32>> for NonZeroU128

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

Attempts to convert NonZeroI32 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i32>> for NonZeroU16

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

Attempts to convert NonZeroI32 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i32>> for NonZeroU32

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

Attempts to convert NonZeroI32 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i32>> for NonZeroU64

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

Attempts to convert NonZeroI32 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i32>> for NonZeroU8

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

Attempts to convert NonZeroI32 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i32>> for NonZeroUsize

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

Attempts to convert NonZeroI32 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroI16

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

Attempts to convert NonZeroI64 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroI32

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

Attempts to convert NonZeroI64 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroI8

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

Attempts to convert NonZeroI64 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroIsize

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

Attempts to convert NonZeroI64 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroU128

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

Attempts to convert NonZeroI64 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroU16

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

Attempts to convert NonZeroI64 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroU32

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

Attempts to convert NonZeroI64 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroU64

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

Attempts to convert NonZeroI64 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroU8

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

Attempts to convert NonZeroI64 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i64>> for NonZeroUsize

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

Attempts to convert NonZeroI64 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i8>> for NonZeroU128

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

Attempts to convert NonZeroI8 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i8>> for NonZeroU16

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

Attempts to convert NonZeroI8 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i8>> for NonZeroU32

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

Attempts to convert NonZeroI8 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i8>> for NonZeroU64

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

Attempts to convert NonZeroI8 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i8>> for NonZeroU8

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

Attempts to convert NonZeroI8 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<i8>> for NonZeroUsize

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

Attempts to convert NonZeroI8 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroI128

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

Attempts to convert NonZeroIsize to NonZeroI128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroI16

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

Attempts to convert NonZeroIsize to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroI32

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

Attempts to convert NonZeroIsize to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroI64

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

Attempts to convert NonZeroIsize to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroI8

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

Attempts to convert NonZeroIsize to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroU128

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

Attempts to convert NonZeroIsize to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroU16

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

Attempts to convert NonZeroIsize to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroU32

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

Attempts to convert NonZeroIsize to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroU64

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

Attempts to convert NonZeroIsize to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroU8

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

Attempts to convert NonZeroIsize to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<isize>> for NonZeroUsize

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

Attempts to convert NonZeroIsize to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroI128

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

Attempts to convert NonZeroU128 to NonZeroI128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroI16

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

Attempts to convert NonZeroU128 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroI32

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

Attempts to convert NonZeroU128 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroI64

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

Attempts to convert NonZeroU128 to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroI8

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

Attempts to convert NonZeroU128 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroIsize

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

Attempts to convert NonZeroU128 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroU16

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

Attempts to convert NonZeroU128 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroU32

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

Attempts to convert NonZeroU128 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroU64

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

Attempts to convert NonZeroU128 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroU8

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

Attempts to convert NonZeroU128 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u128>> for NonZeroUsize

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

Attempts to convert NonZeroU128 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u16>> for NonZeroI16

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

Attempts to convert NonZeroU16 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u16>> for NonZeroI8

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

Attempts to convert NonZeroU16 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u16>> for NonZeroIsize

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

Attempts to convert NonZeroU16 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u16>> for NonZeroU8

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

Attempts to convert NonZeroU16 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u32>> for NonZeroI16

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

Attempts to convert NonZeroU32 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u32>> for NonZeroI32

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

Attempts to convert NonZeroU32 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u32>> for NonZeroI8

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

Attempts to convert NonZeroU32 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u32>> for NonZeroIsize

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

Attempts to convert NonZeroU32 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u32>> for NonZeroU16

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

Attempts to convert NonZeroU32 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u32>> for NonZeroU8

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

Attempts to convert NonZeroU32 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u32>> for NonZeroUsize

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

Attempts to convert NonZeroU32 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u64>> for NonZeroI16

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

Attempts to convert NonZeroU64 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u64>> for NonZeroI32

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

Attempts to convert NonZeroU64 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u64>> for NonZeroI64

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

Attempts to convert NonZeroU64 to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u64>> for NonZeroI8

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

Attempts to convert NonZeroU64 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u64>> for NonZeroIsize

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

Attempts to convert NonZeroU64 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u64>> for NonZeroU16

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

Attempts to convert NonZeroU64 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u64>> for NonZeroU32

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

Attempts to convert NonZeroU64 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u64>> for NonZeroU8

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

Attempts to convert NonZeroU64 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u64>> for NonZeroUsize

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

Attempts to convert NonZeroU64 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<u8>> for NonZeroI8

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

Attempts to convert NonZeroU8 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for Alignment

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<NonZero<usize>> for NonZeroI128

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

Attempts to convert NonZeroUsize to NonZeroI128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroI16

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

Attempts to convert NonZeroUsize to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroI32

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

Attempts to convert NonZeroUsize to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroI64

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

Attempts to convert NonZeroUsize to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroI8

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

Attempts to convert NonZeroUsize to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroIsize

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

Attempts to convert NonZeroUsize to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroU128

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

Attempts to convert NonZeroUsize to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroU16

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

Attempts to convert NonZeroUsize to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroU32

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

Attempts to convert NonZeroUsize to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroU64

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

Attempts to convert NonZeroUsize to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZero<usize>> for NonZeroU8

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

Attempts to convert NonZeroUsize to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.