Struct core::num::NonZeroU32
1.28.0 · source · [−]#[repr(transparent)]pub struct NonZeroU32(_);
Expand description
An integer that is known not to equal zero.
This enables some memory layout optimization.
For example, Option<NonZeroU32>
is the same size as u32
:
use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroU32>>(), size_of::<u32>());
RunImplementations
sourceimpl NonZeroU32
impl NonZeroU32
const: 1.28.0 · sourcepub const unsafe fn new_unchecked(n: u32) -> Self
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.
sourceimpl NonZeroU32
impl NonZeroU32
1.53.0 (const: 1.53.0) · sourcepub const fn leading_zeros(self) -> u32
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);
Run1.53.0 (const: 1.53.0) · sourcepub const fn trailing_zeros(self) -> u32
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);
Runsourceimpl NonZeroU32
impl NonZeroU32
sourcepub const fn checked_add(self, other: u32) -> Option<NonZeroU32>
pub const fn checked_add(self, other: u32) -> Option<NonZeroU32>
Add an unsigned integer to a non-zero value.
Check for overflow and return None
on overflow
As a consequence, the result cannot wrap to zero.
Examples
#![feature(nonzero_ops)]
let one = 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));
Runsourcepub const fn saturating_add(self, other: u32) -> NonZeroU32
pub const fn saturating_add(self, other: u32) -> NonZeroU32
sourcepub const unsafe fn unchecked_add(self, other: u32) -> NonZeroU32
pub const unsafe fn unchecked_add(self, other: u32) -> NonZeroU32
Add an unsigned integer to a non-zero value,
assuming overflow cannot occur.
Overflow is unchecked, and it is undefined behaviour to overflow
even if the result would wrap to a non-zero value.
The behaviour is undefined as soon as
self + rhs > u32::MAX
.
Examples
#![feature(nonzero_ops)]
let one = NonZeroU32::new(1)?;
let two = NonZeroU32::new(2)?;
assert_eq!(two, unsafe { one.unchecked_add(1) });
Runsourcepub const fn checked_next_power_of_two(self) -> Option<NonZeroU32>
pub const fn checked_next_power_of_two(self) -> Option<NonZeroU32>
Returns the smallest power of two greater than or equal to n.
Check for overflow and return None
if the next power of two is greater than the type’s maximum value.
As a consequence, the result cannot wrap to zero.
Examples
#![feature(nonzero_ops)]
let two = 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() );
Runsourcepub const fn log2(self) -> u32
pub const fn log2(self) -> u32
Returns the base 2 logarithm of the number, rounded down.
This is the same operation as
u32::log2
,
except that it has no failure cases to worry about
since this value can never be zero.
Examples
#![feature(int_log)]
assert_eq!(NonZeroU32::new(7).unwrap().log2(), 2);
assert_eq!(NonZeroU32::new(8).unwrap().log2(), 3);
assert_eq!(NonZeroU32::new(9).unwrap().log2(), 3);
Runsourcepub const fn log10(self) -> u32
pub const fn log10(self) -> u32
Returns the base 10 logarithm of the number, rounded down.
This is the same operation as
u32::log10
,
except that it has no failure cases to worry about
since this value can never be zero.
Examples
#![feature(int_log)]
assert_eq!(NonZeroU32::new(99).unwrap().log10(), 1);
assert_eq!(NonZeroU32::new(100).unwrap().log10(), 2);
assert_eq!(NonZeroU32::new(101).unwrap().log10(), 2);
Runsourceimpl NonZeroU32
impl NonZeroU32
sourcepub const fn checked_mul(self, other: NonZeroU32) -> Option<NonZeroU32>
pub const fn checked_mul(self, other: NonZeroU32) -> Option<NonZeroU32>
Multiply two non-zero integers together.
Check for overflow and return None
on overflow.
As a consequence, the result cannot wrap to zero.
Examples
#![feature(nonzero_ops)]
let two = 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));
Runsourcepub const fn saturating_mul(self, other: NonZeroU32) -> NonZeroU32
pub const fn saturating_mul(self, other: NonZeroU32) -> NonZeroU32
sourcepub const unsafe fn unchecked_mul(self, other: NonZeroU32) -> NonZeroU32
pub const unsafe fn unchecked_mul(self, other: NonZeroU32) -> NonZeroU32
Multiply two non-zero integers together,
assuming overflow cannot occur.
Overflow is unchecked, and it is undefined behaviour to overflow
even if the result would wrap to a non-zero value.
The behaviour is undefined as soon as
self * rhs > u32::MAX
.
Examples
#![feature(nonzero_ops)]
let two = NonZeroU32::new(2)?;
let four = NonZeroU32::new(4)?;
assert_eq!(four, unsafe { two.unchecked_mul(two) });
Runsourcepub const fn checked_pow(self, other: u32) -> Option<NonZeroU32>
pub const fn checked_pow(self, other: u32) -> Option<NonZeroU32>
Raise non-zero value to an integer power.
Check for overflow and return None
on overflow.
As a consequence, the result cannot wrap to zero.
Examples
#![feature(nonzero_ops)]
let three = 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));
Runsourcepub const fn saturating_pow(self, other: u32) -> NonZeroU32
pub const fn saturating_pow(self, other: u32) -> NonZeroU32
Raise non-zero value to an integer power.
Return u32::MAX
on overflow.
Examples
#![feature(nonzero_ops)]
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));
Runsourceimpl NonZeroU32
impl NonZeroU32
1.59.0 (const: 1.59.0) · sourcepub const fn is_power_of_two(self) -> bool
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());
RunTrait Implementations
sourceimpl Binary for NonZeroU32
impl Binary for NonZeroU32
1.45.0 (const: unstable) · sourceimpl BitOr<NonZeroU32> for NonZeroU32
impl BitOr<NonZeroU32> for NonZeroU32
1.45.0 (const: unstable) · sourceimpl BitOr<NonZeroU32> for u32
impl BitOr<NonZeroU32> for u32
type Output = NonZeroU32
type Output = NonZeroU32
The resulting type after applying the |
operator.
1.45.0 (const: unstable) · sourceimpl BitOr<u32> for NonZeroU32
impl BitOr<u32> for NonZeroU32
1.45.0 (const: unstable) · sourceimpl BitOrAssign<NonZeroU32> for NonZeroU32
impl BitOrAssign<NonZeroU32> for NonZeroU32
const: unstable · sourcefn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
Performs the |=
operation. Read more
1.45.0 (const: unstable) · sourceimpl BitOrAssign<u32> for NonZeroU32
impl BitOrAssign<u32> for NonZeroU32
const: unstable · sourcefn bitor_assign(&mut self, rhs: u32)
fn bitor_assign(&mut self, rhs: u32)
Performs the |=
operation. Read more
sourceimpl Clone for NonZeroU32
impl Clone for NonZeroU32
sourcefn clone(&self) -> NonZeroU32
fn clone(&self) -> NonZeroU32
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for NonZeroU32
impl Debug for NonZeroU32
sourceimpl Display for NonZeroU32
impl Display for NonZeroU32
1.51.0 (const: unstable) · sourceimpl Div<NonZeroU32> for u32
impl Div<NonZeroU32> for u32
1.41.0 (const: unstable) · sourceimpl From<NonZeroU16> for NonZeroU32
impl From<NonZeroU16> for NonZeroU32
const: unstable · sourcefn from(small: NonZeroU16) -> Self
fn from(small: NonZeroU16) -> Self
Converts NonZeroU16
to NonZeroU32
losslessly.
1.31.0 (const: unstable) · sourceimpl From<NonZeroU32> for u32
impl From<NonZeroU32> for u32
const: unstable · sourcefn from(nonzero: NonZeroU32) -> Self
fn from(nonzero: NonZeroU32) -> Self
Converts a NonZeroU32
into an u32
1.41.0 (const: unstable) · sourceimpl From<NonZeroU32> for NonZeroU64
impl From<NonZeroU32> for NonZeroU64
const: unstable · sourcefn from(small: NonZeroU32) -> Self
fn from(small: NonZeroU32) -> Self
Converts NonZeroU32
to NonZeroU64
losslessly.
1.41.0 (const: unstable) · sourceimpl From<NonZeroU32> for NonZeroU128
impl From<NonZeroU32> for NonZeroU128
const: unstable · sourcefn from(small: NonZeroU32) -> Self
fn from(small: NonZeroU32) -> Self
Converts NonZeroU32
to NonZeroU128
losslessly.
1.41.0 (const: unstable) · sourceimpl From<NonZeroU32> for NonZeroI64
impl From<NonZeroU32> for NonZeroI64
const: unstable · sourcefn from(small: NonZeroU32) -> Self
fn from(small: NonZeroU32) -> Self
Converts NonZeroU32
to NonZeroI64
losslessly.
1.41.0 (const: unstable) · sourceimpl From<NonZeroU32> for NonZeroI128
impl From<NonZeroU32> for NonZeroI128
const: unstable · sourcefn from(small: NonZeroU32) -> Self
fn from(small: NonZeroU32) -> Self
Converts NonZeroU32
to NonZeroI128
losslessly.
1.41.0 (const: unstable) · sourceimpl From<NonZeroU8> for NonZeroU32
impl From<NonZeroU8> for NonZeroU32
1.35.0 · sourceimpl FromStr for NonZeroU32
impl FromStr for NonZeroU32
sourceimpl Hash for NonZeroU32
impl Hash for NonZeroU32
sourceimpl LowerHex for NonZeroU32
impl LowerHex for NonZeroU32
sourceimpl Octal for NonZeroU32
impl Octal for NonZeroU32
sourceimpl Ord for NonZeroU32
impl Ord for NonZeroU32
sourcefn cmp(&self, other: &NonZeroU32) -> Ordering
fn cmp(&self, other: &NonZeroU32) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self where
Self: Sized,
fn max(self, other: Self) -> Self where
Self: Sized,
Compares and returns the maximum of two values. Read more
sourceimpl PartialEq<NonZeroU32> for NonZeroU32
impl PartialEq<NonZeroU32> for NonZeroU32
sourcefn eq(&self, other: &NonZeroU32) -> bool
fn eq(&self, other: &NonZeroU32) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &NonZeroU32) -> bool
fn ne(&self, other: &NonZeroU32) -> bool
This method tests for !=
.
sourceimpl PartialOrd<NonZeroU32> for NonZeroU32
impl PartialOrd<NonZeroU32> for NonZeroU32
sourcefn partial_cmp(&self, other: &NonZeroU32) -> Option<Ordering>
fn partial_cmp(&self, other: &NonZeroU32) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
1.51.0 (const: unstable) · sourceimpl Rem<NonZeroU32> for u32
impl Rem<NonZeroU32> for u32
1.49.0 · sourceimpl TryFrom<NonZeroI128> for NonZeroU32
impl TryFrom<NonZeroI128> for NonZeroU32
sourcefn try_from(value: NonZeroI128) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI128) -> Result<Self, Self::Error>
Attempts to convert NonZeroI128
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI16> for NonZeroU32
impl TryFrom<NonZeroI16> for NonZeroU32
sourcefn try_from(value: NonZeroI16) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI16) -> Result<Self, Self::Error>
Attempts to convert NonZeroI16
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI32> for NonZeroU32
impl TryFrom<NonZeroI32> for NonZeroU32
sourcefn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI64> for NonZeroU32
impl TryFrom<NonZeroI64> for NonZeroU32
sourcefn try_from(value: NonZeroI64) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI64) -> Result<Self, Self::Error>
Attempts to convert NonZeroI64
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI8> for NonZeroU32
impl TryFrom<NonZeroI8> for NonZeroU32
1.49.0 · sourceimpl TryFrom<NonZeroIsize> for NonZeroU32
impl TryFrom<NonZeroIsize> for NonZeroU32
sourcefn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU128> for NonZeroU32
impl TryFrom<NonZeroU128> for NonZeroU32
sourcefn try_from(value: NonZeroU128) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>
Attempts to convert NonZeroU128
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU32> for NonZeroU8
impl TryFrom<NonZeroU32> for NonZeroU8
sourcefn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
Attempts to convert NonZeroU32
to NonZeroU8
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU32> for NonZeroU16
impl TryFrom<NonZeroU32> for NonZeroU16
sourcefn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
Attempts to convert NonZeroU32
to NonZeroU16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU32> for NonZeroUsize
impl TryFrom<NonZeroU32> for NonZeroUsize
sourcefn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
Attempts to convert NonZeroU32
to NonZeroUsize
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU32> for NonZeroI8
impl TryFrom<NonZeroU32> for NonZeroI8
sourcefn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
Attempts to convert NonZeroU32
to NonZeroI8
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU32> for NonZeroI16
impl TryFrom<NonZeroU32> for NonZeroI16
sourcefn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
Attempts to convert NonZeroU32
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU32> for NonZeroI32
impl TryFrom<NonZeroU32> for NonZeroI32
sourcefn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
Attempts to convert NonZeroU32
to NonZeroI32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU32> for NonZeroIsize
impl TryFrom<NonZeroU32> for NonZeroIsize
sourcefn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU32) -> Result<Self, Self::Error>
Attempts to convert NonZeroU32
to NonZeroIsize
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU64> for NonZeroU32
impl TryFrom<NonZeroU64> for NonZeroU32
sourcefn try_from(value: NonZeroU64) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU64) -> Result<Self, Self::Error>
Attempts to convert NonZeroU64
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroUsize> for NonZeroU32
impl TryFrom<NonZeroUsize> for NonZeroU32
sourcefn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroUsize
to NonZeroU32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.46.0 · sourceimpl TryFrom<u32> for NonZeroU32
impl TryFrom<u32> for NonZeroU32
sourceimpl UpperHex for NonZeroU32
impl UpperHex for NonZeroU32
impl Copy for NonZeroU32
impl Eq for NonZeroU32
impl StructuralEq for NonZeroU32
impl StructuralPartialEq for NonZeroU32
Auto Trait Implementations
impl RefUnwindSafe for NonZeroU32
impl Send for NonZeroU32
impl Sync for NonZeroU32
impl Unpin for NonZeroU32
impl UnwindSafe for NonZeroU32
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more