Struct core::num::NonZeroI32
1.34.0 · source · [−]#[repr(transparent)]pub struct NonZeroI32(_);
Expand description
An integer that is known not to equal zero.
This enables some memory layout optimization.
For example, Option<NonZeroI32>
is the same size as i32
:
use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroI32>>(), size_of::<i32>());
RunImplementations
sourceimpl NonZeroI32
impl NonZeroI32
const: 1.34.0 · sourcepub const unsafe fn new_unchecked(n: i32) -> Self
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.
sourceimpl NonZeroI32
impl NonZeroI32
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::NonZeroI32::new(-1i32).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::NonZeroI32::new(0b0101000).unwrap();
assert_eq!(n.trailing_zeros(), 3);
Runsourceimpl NonZeroI32
impl NonZeroI32
sourcepub const fn abs(self) -> NonZeroI32
pub const fn abs(self) -> NonZeroI32
sourcepub const fn checked_abs(self) -> Option<NonZeroI32>
pub const fn checked_abs(self) -> Option<NonZeroI32>
Checked absolute value.
Check for overflow and returns None
if
self == i32::MIN
.
The result cannot be zero.
Example
#![feature(nonzero_ops)]
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());
Runsourcepub const fn overflowing_abs(self) -> (NonZeroI32, bool)
pub const fn overflowing_abs(self) -> (NonZeroI32, bool)
Computes the absolute value of self,
with overflow information, see
i32::overflowing_abs
.
Example
#![feature(nonzero_ops)]
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());
Runsourcepub const fn saturating_abs(self) -> NonZeroI32
pub const fn saturating_abs(self) -> NonZeroI32
Saturating absolute value, see
i32::saturating_abs
.
Example
#![feature(nonzero_ops)]
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());
Runsourcepub const fn wrapping_abs(self) -> NonZeroI32
pub const fn wrapping_abs(self) -> NonZeroI32
Wrapping absolute value, see
i32::wrapping_abs
.
Example
#![feature(nonzero_ops)]
let pos = NonZeroI32::new(1)?;
let neg = NonZeroI32::new(-1)?;
let min = NonZeroI32::new(i32::MIN)?;
let max = NonZeroI32::new(i32::MAX)?;
assert_eq!(pos, pos.wrapping_abs());
assert_eq!(pos, neg.wrapping_abs());
assert_eq!(min, min.wrapping_abs());
Runsourcepub const fn unsigned_abs(self) -> NonZeroU32
pub const fn unsigned_abs(self) -> NonZeroU32
Computes the absolute value of self without any wrapping or panicking.
Example
#![feature(nonzero_ops)]
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());
Runsourceimpl NonZeroI32
impl NonZeroI32
sourcepub const fn checked_mul(self, other: NonZeroI32) -> Option<NonZeroI32>
pub const fn checked_mul(self, other: NonZeroI32) -> Option<NonZeroI32>
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 = 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));
Runsourcepub const fn saturating_mul(self, other: NonZeroI32) -> NonZeroI32
pub const fn saturating_mul(self, other: NonZeroI32) -> NonZeroI32
sourcepub const unsafe fn unchecked_mul(self, other: NonZeroI32) -> NonZeroI32
pub const unsafe fn unchecked_mul(self, other: NonZeroI32) -> NonZeroI32
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 > 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) });
Runsourcepub const fn checked_pow(self, other: u32) -> Option<NonZeroI32>
pub const fn checked_pow(self, other: u32) -> Option<NonZeroI32>
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 = 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));
Runsourcepub const fn saturating_pow(self, other: u32) -> NonZeroI32
pub const fn saturating_pow(self, other: u32) -> NonZeroI32
Raise non-zero value to an integer power.
Return i32::MIN
or i32::MAX
on overflow.
Examples
#![feature(nonzero_ops)]
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));
Runsourceimpl NonZeroI32
impl NonZeroI32
sourcepub const MIN: Self = Self::new(i32::MIN).unwrap()
pub const MIN: Self = Self::new(i32::MIN).unwrap()
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
#![feature(nonzero_min_max)]
assert_eq!(NonZeroI32::MIN.get(), i32::MIN);
Runsourcepub const MAX: Self = Self::new(i32::MAX).unwrap()
pub const MAX: Self = Self::new(i32::MAX).unwrap()
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
#![feature(nonzero_min_max)]
assert_eq!(NonZeroI32::MAX.get(), i32::MAX);
RunTrait Implementations
sourceimpl Binary for NonZeroI32
impl Binary for NonZeroI32
1.45.0 (const: unstable) · sourceimpl BitOr<NonZeroI32> for NonZeroI32
impl BitOr<NonZeroI32> for NonZeroI32
1.45.0 (const: unstable) · sourceimpl BitOr<NonZeroI32> for i32
impl BitOr<NonZeroI32> for i32
type Output = NonZeroI32
type Output = NonZeroI32
The resulting type after applying the |
operator.
1.45.0 (const: unstable) · sourceimpl BitOr<i32> for NonZeroI32
impl BitOr<i32> for NonZeroI32
1.45.0 (const: unstable) · sourceimpl BitOrAssign<NonZeroI32> for NonZeroI32
impl BitOrAssign<NonZeroI32> for NonZeroI32
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<i32> for NonZeroI32
impl BitOrAssign<i32> for NonZeroI32
const: unstable · sourcefn bitor_assign(&mut self, rhs: i32)
fn bitor_assign(&mut self, rhs: i32)
Performs the |=
operation. Read more
sourceimpl Clone for NonZeroI32
impl Clone for NonZeroI32
sourcefn clone(&self) -> NonZeroI32
fn clone(&self) -> NonZeroI32
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 NonZeroI32
impl Debug for NonZeroI32
sourceimpl Display for NonZeroI32
impl Display for NonZeroI32
1.41.0 (const: unstable) · sourceimpl From<NonZeroI16> for NonZeroI32
impl From<NonZeroI16> for NonZeroI32
const: unstable · sourcefn from(small: NonZeroI16) -> Self
fn from(small: NonZeroI16) -> Self
Converts NonZeroI16
to NonZeroI32
losslessly.
1.31.0 (const: unstable) · sourceimpl From<NonZeroI32> for i32
impl From<NonZeroI32> for i32
const: unstable · sourcefn from(nonzero: NonZeroI32) -> Self
fn from(nonzero: NonZeroI32) -> Self
Converts a NonZeroI32
into an i32
1.41.0 (const: unstable) · sourceimpl From<NonZeroI32> for NonZeroI64
impl From<NonZeroI32> for NonZeroI64
const: unstable · sourcefn from(small: NonZeroI32) -> Self
fn from(small: NonZeroI32) -> Self
Converts NonZeroI32
to NonZeroI64
losslessly.
1.41.0 (const: unstable) · sourceimpl From<NonZeroI32> for NonZeroI128
impl From<NonZeroI32> for NonZeroI128
const: unstable · sourcefn from(small: NonZeroI32) -> Self
fn from(small: NonZeroI32) -> Self
Converts NonZeroI32
to NonZeroI128
losslessly.
1.41.0 (const: unstable) · sourceimpl From<NonZeroI8> for NonZeroI32
impl From<NonZeroI8> for NonZeroI32
1.41.0 (const: unstable) · sourceimpl From<NonZeroU16> for NonZeroI32
impl From<NonZeroU16> for NonZeroI32
const: unstable · sourcefn from(small: NonZeroU16) -> Self
fn from(small: NonZeroU16) -> Self
Converts NonZeroU16
to NonZeroI32
losslessly.
1.41.0 (const: unstable) · sourceimpl From<NonZeroU8> for NonZeroI32
impl From<NonZeroU8> for NonZeroI32
1.35.0 · sourceimpl FromStr for NonZeroI32
impl FromStr for NonZeroI32
sourceimpl Hash for NonZeroI32
impl Hash for NonZeroI32
sourceimpl LowerHex for NonZeroI32
impl LowerHex for NonZeroI32
sourceimpl Octal for NonZeroI32
impl Octal for NonZeroI32
sourceimpl Ord for NonZeroI32
impl Ord for NonZeroI32
sourcefn cmp(&self, other: &NonZeroI32) -> Ordering
fn cmp(&self, other: &NonZeroI32) -> 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<NonZeroI32> for NonZeroI32
impl PartialEq<NonZeroI32> for NonZeroI32
sourcefn eq(&self, other: &NonZeroI32) -> bool
fn eq(&self, other: &NonZeroI32) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &NonZeroI32) -> bool
fn ne(&self, other: &NonZeroI32) -> bool
This method tests for !=
.
sourceimpl PartialOrd<NonZeroI32> for NonZeroI32
impl PartialOrd<NonZeroI32> for NonZeroI32
sourcefn partial_cmp(&self, other: &NonZeroI32) -> Option<Ordering>
fn partial_cmp(&self, other: &NonZeroI32) -> 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.49.0 · sourceimpl TryFrom<NonZeroI128> for NonZeroI32
impl TryFrom<NonZeroI128> for NonZeroI32
sourcefn try_from(value: NonZeroI128) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI128) -> Result<Self, Self::Error>
Attempts to convert NonZeroI128
to NonZeroI32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI32> for NonZeroU8
impl TryFrom<NonZeroI32> for NonZeroU8
sourcefn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroU8
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI32> for NonZeroU16
impl TryFrom<NonZeroI32> for NonZeroU16
sourcefn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroU16
.
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<NonZeroI32> for NonZeroU64
impl TryFrom<NonZeroI32> for NonZeroU64
sourcefn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroU64
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI32> for NonZeroU128
impl TryFrom<NonZeroI32> for NonZeroU128
sourcefn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroU128
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI32> for NonZeroUsize
impl TryFrom<NonZeroI32> for NonZeroUsize
sourcefn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroUsize
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI32> for NonZeroI8
impl TryFrom<NonZeroI32> for NonZeroI8
sourcefn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroI8
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI32> for NonZeroI16
impl TryFrom<NonZeroI32> for NonZeroI16
sourcefn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroI16
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI32> for NonZeroIsize
impl TryFrom<NonZeroI32> for NonZeroIsize
sourcefn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroIsize
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroI64> for NonZeroI32
impl TryFrom<NonZeroI64> for NonZeroI32
sourcefn try_from(value: NonZeroI64) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI64) -> Result<Self, Self::Error>
Attempts to convert NonZeroI64
to NonZeroI32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroIsize> for NonZeroI32
impl TryFrom<NonZeroIsize> for NonZeroI32
sourcefn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroI32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroU128> for NonZeroI32
impl TryFrom<NonZeroU128> for NonZeroI32
sourcefn try_from(value: NonZeroU128) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>
Attempts to convert NonZeroU128
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 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<NonZeroU64> for NonZeroI32
impl TryFrom<NonZeroU64> for NonZeroI32
sourcefn try_from(value: NonZeroU64) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU64) -> Result<Self, Self::Error>
Attempts to convert NonZeroU64
to NonZeroI32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.49.0 · sourceimpl TryFrom<NonZeroUsize> for NonZeroI32
impl TryFrom<NonZeroUsize> for NonZeroI32
sourcefn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroUsize
to NonZeroI32
.
type Error = TryFromIntError
type Error = TryFromIntError
The type returned in the event of a conversion error.
1.46.0 · sourceimpl TryFrom<i32> for NonZeroI32
impl TryFrom<i32> for NonZeroI32
sourceimpl UpperHex for NonZeroI32
impl UpperHex for NonZeroI32
impl Copy for NonZeroI32
impl Eq for NonZeroI32
impl StructuralEq for NonZeroI32
impl StructuralPartialEq for NonZeroI32
Auto Trait Implementations
impl RefUnwindSafe for NonZeroI32
impl Send for NonZeroI32
impl Sync for NonZeroI32
impl Unpin for NonZeroI32
impl UnwindSafe for NonZeroI32
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