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