Type Alias core::num::NonZeroI128
1.34.0 · source · pub type NonZeroI128 = NonZero<i128>;
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>());
Run§Layout
NonZeroI128
is guaranteed to have the same layout and bit validity as i128
with the exception that 0
is not a valid instance.
Option<NonZeroI128>
is guaranteed to be compatible with i128
,
including in FFI.
Thanks to the null pointer optimization,
NonZeroI128
and Option<NonZeroI128>
are guaranteed to have the same size and alignment:
use std::num::NonZeroI128;
assert_eq!(size_of::<NonZeroI128>(), size_of::<Option<NonZeroI128>>());
assert_eq!(align_of::<NonZeroI128>(), align_of::<Option<NonZeroI128>>());
RunAliased Type§
struct NonZeroI128(/* private fields */);
Implementations§
source§impl 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.
const: 1.47.0 · sourcepub const fn new(n: i128) -> Option<Self>
pub const fn new(n: i128) -> Option<Self>
Creates a non-zero if the given value is not zero.
sourcepub unsafe fn from_mut_unchecked(n: &mut i128) -> &mut Self
🔬This is a nightly-only experimental API. (nonzero_from_mut
#106290)
pub unsafe fn from_mut_unchecked(n: &mut i128) -> &mut Self
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.
sourcepub fn from_mut(n: &mut i128) -> Option<&mut Self>
🔬This is a nightly-only experimental API. (nonzero_from_mut
#106290)
pub fn from_mut(n: &mut i128) -> Option<&mut Self>
nonzero_from_mut
#106290)Converts a primitive mutable reference to a non-zero mutable reference if the referenced integer is not zero.
1.67.0 · sourcepub const BITS: u32 = 128u32
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);
Run1.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);
Runconst: unstable · sourcepub fn count_ones(self) -> NonZeroU32
🔬This is a nightly-only experimental API. (non_zero_count_ones
#120287)
pub fn count_ones(self) -> NonZeroU32
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);
Run1.70.0 · sourcepub const MIN: Self = _
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);
Run1.70.0 · sourcepub const MAX: Self = _
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);
Run1.64.0 (const: 1.64.0) · sourcepub const fn checked_abs(self) -> Option<Self>
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());
Run1.64.0 (const: 1.64.0) · sourcepub const fn overflowing_abs(self) -> (Self, bool)
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());
Run1.64.0 (const: 1.64.0) · sourcepub const fn saturating_abs(self) -> Self
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());
Run1.64.0 (const: 1.64.0) · sourcepub const fn wrapping_abs(self) -> Self
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());
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());
Run1.71.0 (const: 1.71.0) · sourcepub const fn is_positive(self) -> bool
pub const fn is_positive(self) -> bool
1.71.0 (const: 1.71.0) · sourcepub const fn is_negative(self) -> bool
pub const fn is_negative(self) -> bool
1.71.0 (const: 1.71.0) · sourcepub const fn checked_neg(self) -> Option<Self>
pub const fn checked_neg(self) -> Option<Self>
1.71.0 (const: 1.71.0) · sourcepub const fn overflowing_neg(self) -> (Self, bool)
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));
Run1.71.0 (const: 1.71.0) · sourcepub const fn saturating_neg(self) -> Self
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);
Run1.71.0 (const: 1.71.0) · sourcepub const fn wrapping_neg(self) -> Self
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);
Run1.64.0 (const: 1.64.0) · sourcepub const fn checked_mul(self, other: Self) -> Option<Self>
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));
Run1.64.0 (const: 1.64.0) · sourcepub const fn saturating_mul(self, other: Self) -> Self
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));
Runsourcepub const unsafe fn unchecked_mul(self, other: Self) -> Self
🔬This is a nightly-only experimental API. (nonzero_ops
#84186)
pub const unsafe fn unchecked_mul(self, other: Self) -> Self
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<Self>
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));
Run1.64.0 (const: 1.64.0) · sourcepub const fn saturating_pow(self, other: u32) -> Self
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));
RunTrait Implementations§
source§impl Binary for NonZeroI128
impl Binary for NonZeroI128
1.45.0 · source§impl BitOr<i128> for NonZeroI128
impl BitOr<i128> for NonZeroI128
1.45.0 · source§impl BitOr for NonZeroI128
impl BitOr for NonZeroI128
1.45.0 · source§impl BitOrAssign<i128> for NonZeroI128
impl BitOrAssign<i128> for NonZeroI128
source§fn bitor_assign(&mut self, rhs: i128)
fn bitor_assign(&mut self, rhs: i128)
|=
operation. Read more1.45.0 · source§impl BitOrAssign for NonZeroI128
impl BitOrAssign for NonZeroI128
source§fn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
|=
operation. Read moresource§impl Clone for NonZeroI128
impl Clone for NonZeroI128
source§impl Debug for NonZeroI128
impl Debug for NonZeroI128
source§impl Display for NonZeroI128
impl Display for NonZeroI128
1.41.0 · source§impl From<NonZero<i16>> for NonZeroI128
impl From<NonZero<i16>> for NonZeroI128
source§fn from(small: NonZeroI16) -> Self
fn from(small: NonZeroI16) -> Self
Converts NonZeroI16
to NonZeroI128
losslessly.
1.41.0 · source§impl From<NonZero<i32>> for NonZeroI128
impl From<NonZero<i32>> for NonZeroI128
source§fn from(small: NonZeroI32) -> Self
fn from(small: NonZeroI32) -> Self
Converts NonZeroI32
to NonZeroI128
losslessly.
1.41.0 · source§impl From<NonZero<i64>> for NonZeroI128
impl From<NonZero<i64>> for NonZeroI128
source§fn from(small: NonZeroI64) -> Self
fn from(small: NonZeroI64) -> Self
Converts NonZeroI64
to NonZeroI128
losslessly.
1.41.0 · source§impl From<NonZero<u16>> for NonZeroI128
impl From<NonZero<u16>> for NonZeroI128
source§fn from(small: NonZeroU16) -> Self
fn from(small: NonZeroU16) -> Self
Converts NonZeroU16
to NonZeroI128
losslessly.
1.41.0 · source§impl From<NonZero<u32>> for NonZeroI128
impl From<NonZero<u32>> for NonZeroI128
source§fn from(small: NonZeroU32) -> Self
fn from(small: NonZeroU32) -> Self
Converts NonZeroU32
to NonZeroI128
losslessly.
1.41.0 · source§impl From<NonZero<u64>> for NonZeroI128
impl From<NonZero<u64>> for NonZeroI128
source§fn from(small: NonZeroU64) -> Self
fn from(small: NonZeroU64) -> Self
Converts NonZeroU64
to NonZeroI128
losslessly.
1.35.0 · source§impl FromStr for NonZeroI128
impl FromStr for NonZeroI128
source§impl Hash for NonZeroI128
impl Hash for NonZeroI128
source§impl LowerHex for NonZeroI128
impl LowerHex for NonZeroI128
1.71.0 · source§impl Neg for &NonZeroI128
impl Neg for &NonZeroI128
1.71.0 · source§impl Neg for NonZeroI128
impl Neg for NonZeroI128
source§impl Octal for NonZeroI128
impl Octal for NonZeroI128
source§impl PartialEq for NonZeroI128
impl PartialEq for NonZeroI128
source§impl PartialOrd for NonZeroI128
impl PartialOrd for NonZeroI128
1.49.0 · source§impl TryFrom<NonZero<isize>> for NonZeroI128
impl TryFrom<NonZero<isize>> 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<NonZero<u128>> for NonZeroI128
impl TryFrom<NonZero<u128>> for NonZeroI128
source§fn 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 · source§impl TryFrom<NonZero<usize>> for NonZeroI128
impl TryFrom<NonZero<usize>> for NonZeroI128
source§fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroUsize
to NonZeroI128
.