Type Alias tracing::stdlib::num::NonZeroI64
1.34.0 · source · pub type NonZeroI64 = NonZero<i64>;
Expand description
An integer that is known not to equal zero.
This enables some memory layout optimization.
For example, Option<NonZeroI64>
is the same size as i64
:
use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroI64>>(), size_of::<i64>());
§Layout
NonZeroI64
is guaranteed to have the same layout and bit validity as i64
with the exception that 0
is not a valid instance.
Option<NonZeroI64>
is guaranteed to be compatible with i64
,
including in FFI.
Thanks to the null pointer optimization,
NonZeroI64
and Option<NonZeroI64>
are guaranteed to have the same size and alignment:
use std::num::NonZeroI64;
assert_eq!(size_of::<NonZeroI64>(), size_of::<Option<NonZeroI64>>());
assert_eq!(align_of::<NonZeroI64>(), align_of::<Option<NonZeroI64>>());
Aliased Type§
struct NonZeroI64(/* private fields */);
Implementations
source§impl<T> NonZero<T>where
T: ZeroablePrimitive,
impl<T> NonZero<T>where
T: ZeroablePrimitive,
1.28.0 (const: 1.47.0) · sourcepub const fn new(n: T) -> Option<NonZero<T>>
pub const fn new(n: T) -> Option<NonZero<T>>
Creates a non-zero if the given value is not zero.
1.28.0 (const: 1.28.0) · sourcepub const unsafe fn new_unchecked(n: T) -> NonZero<T>
pub const unsafe fn new_unchecked(n: T) -> NonZero<T>
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.
sourcepub fn from_mut(n: &mut T) -> Option<&mut NonZero<T>>
🔬This is a nightly-only experimental API. (nonzero_from_mut
#106290)
pub fn from_mut(n: &mut T) -> Option<&mut NonZero<T>>
nonzero_from_mut
#106290)Converts a reference to a non-zero mutable reference if the referenced value is not zero.
sourcepub unsafe fn from_mut_unchecked(n: &mut T) -> &mut NonZero<T>
🔬This is a nightly-only experimental API. (nonzero_from_mut
#106290)
pub unsafe fn from_mut_unchecked(n: &mut T) -> &mut NonZero<T>
nonzero_from_mut
#106290)Converts a mutable reference to a non-zero mutable reference without checking whether the referenced value is non-zero. This results in undefined behavior if the referenced value is zero.
§Safety
The referenced value must not be zero.
source§impl NonZero<i64>
impl NonZero<i64>
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 = NonZero::<i64>::new(-1i64)?;
assert_eq!(n.leading_zeros(), 0);
1.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 = NonZero::<i64>::new(0b0101000)?;
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn count_ones(self) -> NonZero<u32>
🔬This is a nightly-only experimental API. (non_zero_count_ones
#120287)
pub const fn count_ones(self) -> NonZero<u32>
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 a = NonZero::<i64>::new(0b100_0000)?;
let b = NonZero::<i64>::new(0b100_0011)?;
assert_eq!(a.count_ones(), NonZero::new(1)?);
assert_eq!(b.count_ones(), NonZero::new(3)?);
sourcepub const fn rotate_left(self, n: u32) -> NonZero<i64>
🔬This is a nightly-only experimental API. (nonzero_bitwise
#128281)
pub const fn rotate_left(self, n: u32) -> NonZero<i64>
nonzero_bitwise
#128281)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting integer.
Please note this isn’t the same operation as the <<
shifting operator!
§Examples
Basic usage:
#![feature(nonzero_bitwise)]
let n = NonZero::new(0xaa00000000006e1i64)?;
let m = NonZero::new(0x6e10aa)?;
assert_eq!(n.rotate_left(12), m);
sourcepub const fn rotate_right(self, n: u32) -> NonZero<i64>
🔬This is a nightly-only experimental API. (nonzero_bitwise
#128281)
pub const fn rotate_right(self, n: u32) -> NonZero<i64>
nonzero_bitwise
#128281)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting operator!
§Examples
Basic usage:
#![feature(nonzero_bitwise)]
let n = NonZero::new(0x6e10aai64)?;
let m = NonZero::new(0xaa00000000006e1)?;
assert_eq!(n.rotate_right(12), m);
sourcepub const fn swap_bytes(self) -> NonZero<i64>
🔬This is a nightly-only experimental API. (nonzero_bitwise
#128281)
pub const fn swap_bytes(self) -> NonZero<i64>
nonzero_bitwise
#128281)Reverses the byte order of the integer.
§Examples
Basic usage:
#![feature(nonzero_bitwise)]
let n = NonZero::new(0x1234567890123456i64)?;
let m = n.swap_bytes();
assert_eq!(m, NonZero::new(0x5634129078563412)?);
sourcepub const fn reverse_bits(self) -> NonZero<i64>
🔬This is a nightly-only experimental API. (nonzero_bitwise
#128281)
pub const fn reverse_bits(self) -> NonZero<i64>
nonzero_bitwise
#128281)Reverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.
§Examples
Basic usage:
#![feature(nonzero_bitwise)]
let n = NonZero::new(0x1234567890123456i64)?;
let m = n.reverse_bits();
assert_eq!(m, NonZero::new(0x6a2c48091e6a2c48)?);
sourcepub const fn from_be(x: NonZero<i64>) -> NonZero<i64>
🔬This is a nightly-only experimental API. (nonzero_bitwise
#128281)
pub const fn from_be(x: NonZero<i64>) -> NonZero<i64>
nonzero_bitwise
#128281)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
§Examples
Basic usage:
#![feature(nonzero_bitwise)]
use std::num::NonZeroI64;
let n = NonZero::new(0x1Ai64)?;
if cfg!(target_endian = "big") {
assert_eq!(NonZeroI64::from_be(n), n)
} else {
assert_eq!(NonZeroI64::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: NonZero<i64>) -> NonZero<i64>
🔬This is a nightly-only experimental API. (nonzero_bitwise
#128281)
pub const fn from_le(x: NonZero<i64>) -> NonZero<i64>
nonzero_bitwise
#128281)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
§Examples
Basic usage:
#![feature(nonzero_bitwise)]
use std::num::NonZeroI64;
let n = NonZero::new(0x1Ai64)?;
if cfg!(target_endian = "little") {
assert_eq!(NonZeroI64::from_le(n), n)
} else {
assert_eq!(NonZeroI64::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> NonZero<i64>
🔬This is a nightly-only experimental API. (nonzero_bitwise
#128281)
pub const fn to_be(self) -> NonZero<i64>
nonzero_bitwise
#128281)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
§Examples
Basic usage:
#![feature(nonzero_bitwise)]
let n = NonZero::new(0x1Ai64)?;
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> NonZero<i64>
🔬This is a nightly-only experimental API. (nonzero_bitwise
#128281)
pub const fn to_le(self) -> NonZero<i64>
nonzero_bitwise
#128281)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
§Examples
Basic usage:
#![feature(nonzero_bitwise)]
let n = NonZero::new(0x1Ai64)?;
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
1.70.0 · sourcepub const MIN: NonZero<i64> = _
pub const MIN: NonZero<i64> = _
The smallest value that can be represented by this non-zero
integer type,
equal to i64::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!(NonZero::<i64>::MIN.get(), i64::MIN);
1.70.0 · sourcepub const MAX: NonZero<i64> = _
pub const MAX: NonZero<i64> = _
The largest value that can be represented by this non-zero
integer type,
equal to i64::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!(NonZero::<i64>::MAX.get(), i64::MAX);
1.64.0 (const: 1.64.0) · sourcepub const fn checked_abs(self) -> Option<NonZero<i64>>
pub const fn checked_abs(self) -> Option<NonZero<i64>>
Checked absolute value.
Checks for overflow and returns None
if
self == NonZero::<i64>::MIN
.
The result cannot be zero.
§Example
let pos = NonZero::new(1i64)?;
let neg = NonZero::new(-1i64)?;
let min = NonZero::new(i64::MIN)?;
assert_eq!(Some(pos), neg.checked_abs());
assert_eq!(None, min.checked_abs());
1.64.0 (const: 1.64.0) · sourcepub const fn overflowing_abs(self) -> (NonZero<i64>, bool)
pub const fn overflowing_abs(self) -> (NonZero<i64>, bool)
Computes the absolute value of self,
with overflow information, see
i64::overflowing_abs
.
§Example
let pos = NonZero::new(1i64)?;
let neg = NonZero::new(-1i64)?;
let min = NonZero::new(i64::MIN)?;
assert_eq!((pos, false), pos.overflowing_abs());
assert_eq!((pos, false), neg.overflowing_abs());
assert_eq!((min, true), min.overflowing_abs());
1.64.0 (const: 1.64.0) · sourcepub const fn saturating_abs(self) -> NonZero<i64>
pub const fn saturating_abs(self) -> NonZero<i64>
Saturating absolute value, see
i64::saturating_abs
.
§Example
let pos = NonZero::new(1i64)?;
let neg = NonZero::new(-1i64)?;
let min = NonZero::new(i64::MIN)?;
let min_plus = NonZero::new(i64::MIN + 1)?;
let max = NonZero::new(i64::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());
1.64.0 (const: 1.64.0) · sourcepub const fn wrapping_abs(self) -> NonZero<i64>
pub const fn wrapping_abs(self) -> NonZero<i64>
Wrapping absolute value, see
i64::wrapping_abs
.
§Example
let pos = NonZero::new(1i64)?;
let neg = NonZero::new(-1i64)?;
let min = NonZero::new(i64::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());
1.64.0 (const: 1.64.0) · sourcepub const fn unsigned_abs(self) -> NonZero<u64>
pub const fn unsigned_abs(self) -> NonZero<u64>
Computes the absolute value of self without any wrapping or panicking.
§Example
let u_pos = NonZero::new(1u64)?;
let i_pos = NonZero::new(1i64)?;
let i_neg = NonZero::new(-1i64)?;
let i_min = NonZero::new(i64::MIN)?;
let u_max = NonZero::new(u64::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());
1.71.0 (const: 1.71.0) · sourcepub const fn is_positive(self) -> bool
pub const fn is_positive(self) -> bool
Returns true
if self
is positive and false
if the
number is negative.
§Example
let pos_five = NonZero::new(5i64)?;
let neg_five = NonZero::new(-5i64)?;
assert!(pos_five.is_positive());
assert!(!neg_five.is_positive());
1.71.0 (const: 1.71.0) · sourcepub const fn is_negative(self) -> bool
pub const fn is_negative(self) -> bool
Returns true
if self
is negative and false
if the
number is positive.
§Example
let pos_five = NonZero::new(5i64)?;
let neg_five = NonZero::new(-5i64)?;
assert!(neg_five.is_negative());
assert!(!pos_five.is_negative());
1.71.0 (const: 1.71.0) · sourcepub const fn checked_neg(self) -> Option<NonZero<i64>>
pub const fn checked_neg(self) -> Option<NonZero<i64>>
Checked negation. Computes -self
,
returning None
if self == NonZero::<i64>::MIN
.
§Example
let pos_five = NonZero::new(5i64)?;
let neg_five = NonZero::new(-5i64)?;
let min = NonZero::new(i64::MIN)?;
assert_eq!(pos_five.checked_neg(), Some(neg_five));
assert_eq!(min.checked_neg(), None);
1.71.0 (const: 1.71.0) · sourcepub const fn overflowing_neg(self) -> (NonZero<i64>, bool)
pub const fn overflowing_neg(self) -> (NonZero<i64>, bool)
Negates self, overflowing if this is equal to the minimum value.
See i64::overflowing_neg
for documentation on overflow behaviour.
§Example
let pos_five = NonZero::new(5i64)?;
let neg_five = NonZero::new(-5i64)?;
let min = NonZero::new(i64::MIN)?;
assert_eq!(pos_five.overflowing_neg(), (neg_five, false));
assert_eq!(min.overflowing_neg(), (min, true));
1.71.0 (const: 1.71.0) · sourcepub const fn saturating_neg(self) -> NonZero<i64>
pub const fn saturating_neg(self) -> NonZero<i64>
Saturating negation. Computes -self
,
returning NonZero::<i64>::MAX
if self == NonZero::<i64>::MIN
instead of overflowing.
§Example
let pos_five = NonZero::new(5i64)?;
let neg_five = NonZero::new(-5i64)?;
let min = NonZero::new(i64::MIN)?;
let min_plus_one = NonZero::new(i64::MIN + 1)?;
let max = NonZero::new(i64::MAX)?;
assert_eq!(pos_five.saturating_neg(), neg_five);
assert_eq!(min.saturating_neg(), max);
assert_eq!(max.saturating_neg(), min_plus_one);
1.71.0 (const: 1.71.0) · sourcepub const fn wrapping_neg(self) -> NonZero<i64>
pub const fn wrapping_neg(self) -> NonZero<i64>
Wrapping (modular) negation. Computes -self
, wrapping around at the boundary
of the type.
See i64::wrapping_neg
for documentation on overflow behaviour.
§Example
let pos_five = NonZero::new(5i64)?;
let neg_five = NonZero::new(-5i64)?;
let min = NonZero::new(i64::MIN)?;
assert_eq!(pos_five.wrapping_neg(), neg_five);
assert_eq!(min.wrapping_neg(), min);
1.64.0 (const: 1.64.0) · sourcepub const fn checked_mul(self, other: NonZero<i64>) -> Option<NonZero<i64>>
pub const fn checked_mul(self, other: NonZero<i64>) -> Option<NonZero<i64>>
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 = NonZero::new(2i64)?;
let four = NonZero::new(4i64)?;
let max = NonZero::new(i64::MAX)?;
assert_eq!(Some(four), two.checked_mul(two));
assert_eq!(None, max.checked_mul(two));
1.64.0 (const: 1.64.0) · sourcepub const fn saturating_mul(self, other: NonZero<i64>) -> NonZero<i64>
pub const fn saturating_mul(self, other: NonZero<i64>) -> NonZero<i64>
Multiplies two non-zero integers together.
Return NonZero::<i64>::MAX
on overflow.
§Examples
let two = NonZero::new(2i64)?;
let four = NonZero::new(4i64)?;
let max = NonZero::new(i64::MAX)?;
assert_eq!(four, two.saturating_mul(two));
assert_eq!(max, four.saturating_mul(max));
sourcepub const unsafe fn unchecked_mul(self, other: NonZero<i64>) -> NonZero<i64>
🔬This is a nightly-only experimental API. (nonzero_ops
#84186)
pub const unsafe fn unchecked_mul(self, other: NonZero<i64>) -> NonZero<i64>
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 > i64::MAX
, or self * rhs < i64::MIN
.
§Examples
#![feature(nonzero_ops)]
let two = NonZero::new(2i64)?;
let four = NonZero::new(4i64)?;
assert_eq!(four, unsafe { two.unchecked_mul(two) });
1.64.0 (const: 1.64.0) · sourcepub const fn checked_pow(self, other: u32) -> Option<NonZero<i64>>
pub const fn checked_pow(self, other: u32) -> Option<NonZero<i64>>
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 = NonZero::new(3i64)?;
let twenty_seven = NonZero::new(27i64)?;
let half_max = NonZero::new(i64::MAX / 2)?;
assert_eq!(Some(twenty_seven), three.checked_pow(3));
assert_eq!(None, half_max.checked_pow(3));
1.64.0 (const: 1.64.0) · sourcepub const fn saturating_pow(self, other: u32) -> NonZero<i64>
pub const fn saturating_pow(self, other: u32) -> NonZero<i64>
Raise non-zero value to an integer power.
Return NonZero::<i64>::MIN
or NonZero::<i64>::MAX
on overflow.
§Examples
let three = NonZero::new(3i64)?;
let twenty_seven = NonZero::new(27i64)?;
let max = NonZero::new(i64::MAX)?;
assert_eq!(twenty_seven, three.saturating_pow(3));
assert_eq!(max, max.saturating_pow(3));
Trait Implementations
1.45.0 · source§impl<T> BitOrAssign<T> for NonZero<T>
impl<T> BitOrAssign<T> for NonZero<T>
source§fn bitor_assign(&mut self, rhs: T)
fn bitor_assign(&mut self, rhs: T)
|=
operation. Read more1.45.0 · source§impl<T> BitOrAssign for NonZero<T>
impl<T> BitOrAssign for NonZero<T>
source§fn bitor_assign(&mut self, rhs: NonZero<T>)
fn bitor_assign(&mut self, rhs: NonZero<T>)
|=
operation. Read more