Struct core::num::NonZeroIsize
1.34.0 · source · #[repr(transparent)]pub struct NonZeroIsize(_);
Expand description
An integer that is known not to equal zero.
This enables some memory layout optimization.
For example, Option<NonZeroIsize>
is the same size as isize
:
use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroIsize>>(), size_of::<isize>());
RunImplementations§
source§impl NonZeroIsize
impl NonZeroIsize
const: 1.34.0 · sourcepub const unsafe fn new_unchecked(n: isize) -> Self
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.
source§impl NonZeroIsize
impl NonZeroIsize
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::NonZeroIsize::new(-1isize).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::NonZeroIsize::new(0b0101000).unwrap();
assert_eq!(n.trailing_zeros(), 3);
Runsource§impl NonZeroIsize
impl NonZeroIsize
1.64.0 (const: 1.64.0) · sourcepub const fn abs(self) -> NonZeroIsize
pub const fn abs(self) -> NonZeroIsize
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());
Run1.64.0 (const: 1.64.0) · sourcepub const fn checked_abs(self) -> Option<NonZeroIsize>
pub const fn checked_abs(self) -> Option<NonZeroIsize>
Checked absolute value.
Checks for overflow and returns None
if
self == isize::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());
Run1.64.0 (const: 1.64.0) · sourcepub const fn overflowing_abs(self) -> (NonZeroIsize, bool)
pub const fn overflowing_abs(self) -> (NonZeroIsize, 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());
Run1.64.0 (const: 1.64.0) · sourcepub const fn saturating_abs(self) -> NonZeroIsize
pub const fn saturating_abs(self) -> NonZeroIsize
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());
Run1.64.0 (const: 1.64.0) · sourcepub const fn wrapping_abs(self) -> NonZeroIsize
pub const fn wrapping_abs(self) -> NonZeroIsize
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());
Run1.64.0 (const: 1.64.0) · sourcepub const fn unsigned_abs(self) -> NonZeroUsize
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());
Runsourcepub const fn is_negative(self) -> bool
🔬This is a nightly-only experimental API. (nonzero_negation_ops
#102443)
pub const fn is_negative(self) -> bool
nonzero_negation_ops
#102443)sourcepub const fn checked_neg(self) -> Option<NonZeroIsize>
🔬This is a nightly-only experimental API. (nonzero_negation_ops
#102443)
pub const fn checked_neg(self) -> Option<NonZeroIsize>
nonzero_negation_ops
#102443)Checked negation. Computes -self
, returning None
if self == i32::MIN
.
Example
#![feature(nonzero_negation_ops)]
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);
Runsourcepub const fn overflowing_neg(self) -> (NonZeroIsize, bool)
🔬This is a nightly-only experimental API. (nonzero_negation_ops
#102443)
pub const fn overflowing_neg(self) -> (NonZeroIsize, bool)
nonzero_negation_ops
#102443)Negates self, overflowing if this is equal to the minimum value.
See isize::overflowing_neg
for documentation on overflow behaviour.
Example
#![feature(nonzero_negation_ops)]
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));
Runsourcepub const fn saturating_neg(self) -> NonZeroIsize
🔬This is a nightly-only experimental API. (nonzero_negation_ops
#102443)
pub const fn saturating_neg(self) -> NonZeroIsize
nonzero_negation_ops
#102443)Saturating negation. Computes -self
, returning MAX
if
self == i32::MIN
instead of overflowing.
Example
#![feature(nonzero_negation_ops)]
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);
Runsourcepub const fn wrapping_neg(self) -> NonZeroIsize
🔬This is a nightly-only experimental API. (nonzero_negation_ops
#102443)
pub const fn wrapping_neg(self) -> NonZeroIsize
nonzero_negation_ops
#102443)Wrapping (modular) negation. Computes -self
, wrapping around at the boundary
of the type.
See isize::wrapping_neg
for documentation on overflow behaviour.
Example
#![feature(nonzero_negation_ops)]
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);
Runsource§impl NonZeroIsize
impl NonZeroIsize
1.64.0 (const: 1.64.0) · sourcepub const fn checked_mul(self, other: NonZeroIsize) -> Option<NonZeroIsize>
pub const fn checked_mul(self, other: NonZeroIsize) -> Option<NonZeroIsize>
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));
Run1.64.0 (const: 1.64.0) · sourcepub const fn saturating_mul(self, other: NonZeroIsize) -> NonZeroIsize
pub const fn saturating_mul(self, other: NonZeroIsize) -> NonZeroIsize
Multiplies two non-zero integers together.
Return isize::MAX
on overflow.
Examples
let two = NonZeroIsize::new(2)?;
let four = NonZeroIsize::new(4)?;
let max = NonZeroIsize::new(isize::MAX)?;
assert_eq!(four, two.saturating_mul(two));
assert_eq!(max, four.saturating_mul(max));
Runsourcepub const unsafe fn unchecked_mul(self, other: NonZeroIsize) -> NonZeroIsize
🔬This is a nightly-only experimental API. (nonzero_ops
#84186)
pub const unsafe fn unchecked_mul(self, other: NonZeroIsize) -> NonZeroIsize
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) });
Run1.64.0 (const: 1.64.0) · sourcepub const fn checked_pow(self, other: u32) -> Option<NonZeroIsize>
pub const fn checked_pow(self, other: u32) -> Option<NonZeroIsize>
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));
Run1.64.0 (const: 1.64.0) · sourcepub const fn saturating_pow(self, other: u32) -> NonZeroIsize
pub const fn saturating_pow(self, other: u32) -> NonZeroIsize
Raise non-zero value to an integer power.
Return isize::MIN
or isize::MAX
on overflow.
Examples
let three = NonZeroIsize::new(3)?;
let twenty_seven = NonZeroIsize::new(27)?;
let max = NonZeroIsize::new(isize::MAX)?;
assert_eq!(twenty_seven, three.saturating_pow(3));
assert_eq!(max, max.saturating_pow(3));
Runsource§impl NonZeroIsize
impl NonZeroIsize
sourcepub const MIN: Self = _
🔬This is a nightly-only experimental API. (nonzero_min_max
#89065)
pub const MIN: Self = _
nonzero_min_max
#89065)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
#![feature(nonzero_min_max)]
assert_eq!(NonZeroIsize::MIN.get(), isize::MIN);
Runsourcepub const MAX: Self = _
🔬This is a nightly-only experimental API. (nonzero_min_max
#89065)
pub const MAX: Self = _
nonzero_min_max
#89065)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
#![feature(nonzero_min_max)]
assert_eq!(NonZeroIsize::MAX.get(), isize::MAX);
Runsource§impl NonZeroIsize
impl NonZeroIsize
Trait Implementations§
source§impl Binary for NonZeroIsize
impl Binary for NonZeroIsize
1.45.0 (const: unstable) · source§impl BitOr<NonZeroIsize> for NonZeroIsize
impl BitOr<NonZeroIsize> for NonZeroIsize
1.45.0 (const: unstable) · source§impl BitOr<NonZeroIsize> for isize
impl BitOr<NonZeroIsize> for isize
§type Output = NonZeroIsize
type Output = NonZeroIsize
|
operator.1.45.0 (const: unstable) · source§impl BitOrAssign<NonZeroIsize> for NonZeroIsize
impl BitOrAssign<NonZeroIsize> for NonZeroIsize
const: unstable · source§fn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
|=
operation. Read more1.45.0 (const: unstable) · source§impl BitOrAssign<isize> for NonZeroIsize
impl BitOrAssign<isize> for NonZeroIsize
source§impl Clone for NonZeroIsize
impl Clone for NonZeroIsize
source§fn clone(&self) -> NonZeroIsize
fn clone(&self) -> NonZeroIsize
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for NonZeroIsize
impl Debug for NonZeroIsize
source§impl Display for NonZeroIsize
impl Display for NonZeroIsize
1.41.0 (const: unstable) · source§impl From<NonZeroI16> for NonZeroIsize
impl From<NonZeroI16> for NonZeroIsize
const: unstable · source§fn from(small: NonZeroI16) -> Self
fn from(small: NonZeroI16) -> Self
Converts NonZeroI16
to NonZeroIsize
losslessly.
1.31.0 (const: unstable) · source§impl From<NonZeroIsize> for isize
impl From<NonZeroIsize> for isize
const: unstable · source§fn from(nonzero: NonZeroIsize) -> Self
fn from(nonzero: NonZeroIsize) -> Self
Converts a NonZeroIsize
into an isize
1.35.0 · source§impl FromStr for NonZeroIsize
impl FromStr for NonZeroIsize
source§impl Hash for NonZeroIsize
impl Hash for NonZeroIsize
source§impl LowerHex for NonZeroIsize
impl LowerHex for NonZeroIsize
source§impl Octal for NonZeroIsize
impl Octal for NonZeroIsize
source§impl Ord for NonZeroIsize
impl Ord for NonZeroIsize
source§fn cmp(&self, other: &NonZeroIsize) -> Ordering
fn cmp(&self, other: &NonZeroIsize) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<NonZeroIsize> for NonZeroIsize
impl PartialEq<NonZeroIsize> for NonZeroIsize
source§fn eq(&self, other: &NonZeroIsize) -> bool
fn eq(&self, other: &NonZeroIsize) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<NonZeroIsize> for NonZeroIsize
impl PartialOrd<NonZeroIsize> for NonZeroIsize
source§fn partial_cmp(&self, other: &NonZeroIsize) -> Option<Ordering>
fn partial_cmp(&self, other: &NonZeroIsize) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more1.49.0 · source§impl TryFrom<NonZeroI128> for NonZeroIsize
impl TryFrom<NonZeroI128> for NonZeroIsize
source§fn try_from(value: NonZeroI128) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI128) -> Result<Self, Self::Error>
Attempts to convert NonZeroI128
to NonZeroIsize
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroI32> for NonZeroIsize
impl TryFrom<NonZeroI32> for NonZeroIsize
source§fn 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
1.49.0 · source§impl TryFrom<NonZeroI64> for NonZeroIsize
impl TryFrom<NonZeroI64> for NonZeroIsize
source§fn try_from(value: NonZeroI64) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI64) -> Result<Self, Self::Error>
Attempts to convert NonZeroI64
to NonZeroIsize
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroI128
impl TryFrom<NonZeroIsize> for NonZeroI128
source§fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroI128
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroI16
impl TryFrom<NonZeroIsize> for NonZeroI16
source§fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroI16
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroI32
impl TryFrom<NonZeroIsize> for NonZeroI32
source§fn 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
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroI64
impl TryFrom<NonZeroIsize> for NonZeroI64
source§fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroI64
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroI8
impl TryFrom<NonZeroIsize> for NonZeroI8
source§fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroI8
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroU128
impl TryFrom<NonZeroIsize> for NonZeroU128
source§fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroU128
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroU16
impl TryFrom<NonZeroIsize> for NonZeroU16
source§fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroU16
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroU32
impl TryFrom<NonZeroIsize> for NonZeroU32
source§fn 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
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroU64
impl TryFrom<NonZeroIsize> for NonZeroU64
source§fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroU64
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroU8
impl TryFrom<NonZeroIsize> for NonZeroU8
source§fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroU8
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroIsize> for NonZeroUsize
impl TryFrom<NonZeroIsize> for NonZeroUsize
source§fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroIsize
to NonZeroUsize
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroIsize
impl TryFrom<NonZeroU128> for NonZeroIsize
source§fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>
Attempts to convert NonZeroU128
to NonZeroIsize
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU16> for NonZeroIsize
impl TryFrom<NonZeroU16> for NonZeroIsize
source§fn try_from(value: NonZeroU16) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU16) -> Result<Self, Self::Error>
Attempts to convert NonZeroU16
to NonZeroIsize
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU32> for NonZeroIsize
impl TryFrom<NonZeroU32> for NonZeroIsize
source§fn 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
1.49.0 · source§impl TryFrom<NonZeroU64> for NonZeroIsize
impl TryFrom<NonZeroU64> for NonZeroIsize
source§fn try_from(value: NonZeroU64) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU64) -> Result<Self, Self::Error>
Attempts to convert NonZeroU64
to NonZeroIsize
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroUsize> for NonZeroIsize
impl TryFrom<NonZeroUsize> for NonZeroIsize
source§fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroUsize
to NonZeroIsize
.