Struct sp_std::num::NonZeroU128
1.28.0 · source · pub struct NonZeroU128(_);
Expand description
An integer that is known not to equal zero.
This enables some memory layout optimization.
For example, Option<NonZeroU128>
is the same size as u128
:
use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroU128>>(), size_of::<u128>());
Layout
NonZeroU128
is guaranteed to have the same layout and bit validity as u128
with the exception that 0
is not a valid instance.
Option<NonZeroU128>
is guaranteed to be compatible with u128
,
including in FFI.
Implementations§
source§impl NonZeroU128
impl NonZeroU128
const: 1.28.0 · sourcepub const unsafe fn new_unchecked(n: u128) -> NonZeroU128
pub const unsafe fn new_unchecked(n: u128) -> NonZeroU128
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: u128) -> Option<NonZeroU128>
pub const fn new(n: u128) -> Option<NonZeroU128>
Creates a non-zero if the given value is not zero.
source§impl NonZeroU128
impl NonZeroU128
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::NonZeroU128::new(u128::MAX).unwrap();
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 = std::num::NonZeroU128::new(0b0101000).unwrap();
assert_eq!(n.trailing_zeros(), 3);
source§impl NonZeroU128
impl NonZeroU128
1.64.0 (const: 1.64.0) · sourcepub const fn checked_add(self, other: u128) -> Option<NonZeroU128>
pub const fn checked_add(self, other: u128) -> Option<NonZeroU128>
Adds an unsigned integer to a non-zero value.
Checks for overflow and returns None
on overflow.
As a consequence, the result cannot wrap to zero.
Examples
let one = NonZeroU128::new(1)?;
let two = NonZeroU128::new(2)?;
let max = NonZeroU128::new(u128::MAX)?;
assert_eq!(Some(two), one.checked_add(1));
assert_eq!(None, max.checked_add(1));
1.64.0 (const: 1.64.0) · sourcepub const fn saturating_add(self, other: u128) -> NonZeroU128
pub const fn saturating_add(self, other: u128) -> NonZeroU128
sourcepub const unsafe fn unchecked_add(self, other: u128) -> NonZeroU128
🔬This is a nightly-only experimental API. (nonzero_ops
)
pub const unsafe fn unchecked_add(self, other: u128) -> NonZeroU128
nonzero_ops
)Adds an unsigned integer to a non-zero value,
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 > u128::MAX
.
Examples
#![feature(nonzero_ops)]
let one = NonZeroU128::new(1)?;
let two = NonZeroU128::new(2)?;
assert_eq!(two, unsafe { one.unchecked_add(1) });
1.64.0 (const: 1.64.0) · sourcepub const fn checked_next_power_of_two(self) -> Option<NonZeroU128>
pub const fn checked_next_power_of_two(self) -> Option<NonZeroU128>
Returns the smallest power of two greater than or equal to n.
Checks for overflow and returns None
if the next power of two is greater than the type’s maximum value.
As a consequence, the result cannot wrap to zero.
Examples
let two = NonZeroU128::new(2)?;
let three = NonZeroU128::new(3)?;
let four = NonZeroU128::new(4)?;
let max = NonZeroU128::new(u128::MAX)?;
assert_eq!(Some(two), two.checked_next_power_of_two() );
assert_eq!(Some(four), three.checked_next_power_of_two() );
assert_eq!(None, max.checked_next_power_of_two() );
1.67.0 (const: 1.67.0) · sourcepub const fn ilog2(self) -> u32
pub const fn ilog2(self) -> u32
Returns the base 2 logarithm of the number, rounded down.
This is the same operation as
u128::ilog2
,
except that it has no failure cases to worry about
since this value can never be zero.
Examples
assert_eq!(NonZeroU128::new(7).unwrap().ilog2(), 2);
assert_eq!(NonZeroU128::new(8).unwrap().ilog2(), 3);
assert_eq!(NonZeroU128::new(9).unwrap().ilog2(), 3);
1.67.0 (const: 1.67.0) · sourcepub const fn ilog10(self) -> u32
pub const fn ilog10(self) -> u32
Returns the base 10 logarithm of the number, rounded down.
This is the same operation as
u128::ilog10
,
except that it has no failure cases to worry about
since this value can never be zero.
Examples
assert_eq!(NonZeroU128::new(99).unwrap().ilog10(), 1);
assert_eq!(NonZeroU128::new(100).unwrap().ilog10(), 2);
assert_eq!(NonZeroU128::new(101).unwrap().ilog10(), 2);
source§impl NonZeroU128
impl NonZeroU128
1.64.0 (const: 1.64.0) · sourcepub const fn checked_mul(self, other: NonZeroU128) -> Option<NonZeroU128>
pub const fn checked_mul(self, other: NonZeroU128) -> Option<NonZeroU128>
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 = NonZeroU128::new(2)?;
let four = NonZeroU128::new(4)?;
let max = NonZeroU128::new(u128::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: NonZeroU128) -> NonZeroU128
pub const fn saturating_mul(self, other: NonZeroU128) -> NonZeroU128
sourcepub const unsafe fn unchecked_mul(self, other: NonZeroU128) -> NonZeroU128
🔬This is a nightly-only experimental API. (nonzero_ops
)
pub const unsafe fn unchecked_mul(self, other: NonZeroU128) -> NonZeroU128
nonzero_ops
)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 > u128::MAX
.
Examples
#![feature(nonzero_ops)]
let two = NonZeroU128::new(2)?;
let four = NonZeroU128::new(4)?;
assert_eq!(four, unsafe { two.unchecked_mul(two) });
1.64.0 (const: 1.64.0) · sourcepub const fn checked_pow(self, other: u32) -> Option<NonZeroU128>
pub const fn checked_pow(self, other: u32) -> Option<NonZeroU128>
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 = NonZeroU128::new(3)?;
let twenty_seven = NonZeroU128::new(27)?;
let half_max = NonZeroU128::new(u128::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) -> NonZeroU128
pub const fn saturating_pow(self, other: u32) -> NonZeroU128
source§impl NonZeroU128
impl NonZeroU128
1.59.0 (const: 1.59.0) · sourcepub const fn is_power_of_two(self) -> bool
pub const fn is_power_of_two(self) -> bool
Returns true
if and only if self == (1 << k)
for some k
.
On many architectures, this function can perform better than is_power_of_two()
on the underlying integer type, as special handling of zero can be avoided.
Examples
Basic usage:
let eight = std::num::NonZeroU128::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroU128::new(10).unwrap();
assert!(!ten.is_power_of_two());
source§impl NonZeroU128
impl NonZeroU128
1.70.0 · sourcepub const MIN: NonZeroU128 = Self::new(1).unwrap()
pub const MIN: NonZeroU128 = Self::new(1).unwrap()
The smallest value that can be represented by this non-zero integer type, 1.
Examples
assert_eq!(NonZeroU128::MIN.get(), 1u128);
1.70.0 · sourcepub const MAX: NonZeroU128 = Self::new(u128::MAX).unwrap()
pub const MAX: NonZeroU128 = Self::new(u128::MAX).unwrap()
source§impl NonZeroU128
impl NonZeroU128
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 u128::BITS
.
Examples
assert_eq!(NonZeroU128::BITS, u128::BITS);
Trait Implementations§
source§impl Binary for NonZeroU128
impl Binary for NonZeroU128
1.45.0 (const: unstable) · source§impl BitOr<NonZeroU128> for NonZeroU128
impl BitOr<NonZeroU128> for NonZeroU128
§type Output = NonZeroU128
type Output = NonZeroU128
|
operator.const: unstable · source§fn bitor(self, rhs: NonZeroU128) -> <NonZeroU128 as BitOr<NonZeroU128>>::Output
fn bitor(self, rhs: NonZeroU128) -> <NonZeroU128 as BitOr<NonZeroU128>>::Output
|
operation. Read more1.45.0 (const: unstable) · source§impl BitOr<NonZeroU128> for u128
impl BitOr<NonZeroU128> for u128
§type Output = NonZeroU128
type Output = NonZeroU128
|
operator.const: unstable · source§fn bitor(self, rhs: NonZeroU128) -> <u128 as BitOr<NonZeroU128>>::Output
fn bitor(self, rhs: NonZeroU128) -> <u128 as BitOr<NonZeroU128>>::Output
|
operation. Read more1.45.0 (const: unstable) · source§impl BitOrAssign<NonZeroU128> for NonZeroU128
impl BitOrAssign<NonZeroU128> for NonZeroU128
const: unstable · source§fn bitor_assign(&mut self, rhs: NonZeroU128)
fn bitor_assign(&mut self, rhs: NonZeroU128)
|=
operation. Read more1.45.0 (const: unstable) · source§impl BitOrAssign<u128> for NonZeroU128
impl BitOrAssign<u128> for NonZeroU128
source§impl Clone for NonZeroU128
impl Clone for NonZeroU128
source§fn clone(&self) -> NonZeroU128
fn clone(&self) -> NonZeroU128
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for NonZeroU128
impl Debug for NonZeroU128
source§impl Display for NonZeroU128
impl Display for NonZeroU128
1.41.0 (const: unstable) · source§impl From<NonZeroU16> for NonZeroU128
impl From<NonZeroU16> for NonZeroU128
const: unstable · source§fn from(small: NonZeroU16) -> NonZeroU128
fn from(small: NonZeroU16) -> NonZeroU128
Converts NonZeroU16
to NonZeroU128
losslessly.
1.41.0 (const: unstable) · source§impl From<NonZeroU32> for NonZeroU128
impl From<NonZeroU32> for NonZeroU128
const: unstable · source§fn from(small: NonZeroU32) -> NonZeroU128
fn from(small: NonZeroU32) -> NonZeroU128
Converts NonZeroU32
to NonZeroU128
losslessly.
1.41.0 (const: unstable) · source§impl From<NonZeroU64> for NonZeroU128
impl From<NonZeroU64> for NonZeroU128
const: unstable · source§fn from(small: NonZeroU64) -> NonZeroU128
fn from(small: NonZeroU64) -> NonZeroU128
Converts NonZeroU64
to NonZeroU128
losslessly.
1.35.0 · source§impl FromStr for NonZeroU128
impl FromStr for NonZeroU128
§type Err = ParseIntError
type Err = ParseIntError
source§fn from_str(src: &str) -> Result<NonZeroU128, <NonZeroU128 as FromStr>::Err>
fn from_str(src: &str) -> Result<NonZeroU128, <NonZeroU128 as FromStr>::Err>
s
to return a value of this type. Read moresource§impl Hash for NonZeroU128
impl Hash for NonZeroU128
source§impl LowerHex for NonZeroU128
impl LowerHex for NonZeroU128
source§impl Octal for NonZeroU128
impl Octal for NonZeroU128
source§impl Ord for NonZeroU128
impl Ord for NonZeroU128
source§fn cmp(&self, other: &NonZeroU128) -> Ordering
fn cmp(&self, other: &NonZeroU128) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<NonZeroU128> for NonZeroU128
impl PartialEq<NonZeroU128> for NonZeroU128
source§fn eq(&self, other: &NonZeroU128) -> bool
fn eq(&self, other: &NonZeroU128) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<NonZeroU128> for NonZeroU128
impl PartialOrd<NonZeroU128> for NonZeroU128
source§fn partial_cmp(&self, other: &NonZeroU128) -> Option<Ordering>
fn partial_cmp(&self, other: &NonZeroU128) -> 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 NonZeroU128
impl TryFrom<NonZeroI128> for NonZeroU128
source§fn try_from(
value: NonZeroI128
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI128>>::Error>
fn try_from( value: NonZeroI128 ) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI128>>::Error>
Attempts to convert NonZeroI128
to NonZeroU128
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroI16> for NonZeroU128
impl TryFrom<NonZeroI16> for NonZeroU128
source§fn try_from(
value: NonZeroI16
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI16>>::Error>
fn try_from( value: NonZeroI16 ) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI16>>::Error>
Attempts to convert NonZeroI16
to NonZeroU128
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroI32> for NonZeroU128
impl TryFrom<NonZeroI32> for NonZeroU128
source§fn try_from(
value: NonZeroI32
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI32>>::Error>
fn try_from( value: NonZeroI32 ) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI32>>::Error>
Attempts to convert NonZeroI32
to NonZeroU128
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroI64> for NonZeroU128
impl TryFrom<NonZeroI64> for NonZeroU128
source§fn try_from(
value: NonZeroI64
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI64>>::Error>
fn try_from( value: NonZeroI64 ) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI64>>::Error>
Attempts to convert NonZeroI64
to NonZeroU128
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroI8> for NonZeroU128
impl TryFrom<NonZeroI8> for NonZeroU128
source§fn try_from(
value: NonZeroI8
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI8>>::Error>
fn try_from( value: NonZeroI8 ) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI8>>::Error>
Attempts to convert NonZeroI8
to NonZeroU128
.
§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<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroIsize>>::Error>
fn try_from( value: NonZeroIsize ) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroIsize>>::Error>
Attempts to convert NonZeroIsize
to NonZeroU128
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroI128
impl TryFrom<NonZeroU128> for NonZeroI128
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroI128, <NonZeroI128 as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroI128, <NonZeroI128 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroI128
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroI16
impl TryFrom<NonZeroU128> for NonZeroI16
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroI16
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroI32
impl TryFrom<NonZeroU128> for NonZeroI32
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroI32
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroI64
impl TryFrom<NonZeroU128> for NonZeroI64
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroI64
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroI8
impl TryFrom<NonZeroU128> for NonZeroI8
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroI8
.
§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<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroIsize
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroU16
impl TryFrom<NonZeroU128> for NonZeroU16
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroU16
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroU32
impl TryFrom<NonZeroU128> for NonZeroU32
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroU32
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroU64
impl TryFrom<NonZeroU128> for NonZeroU64
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroU64
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroU8
impl TryFrom<NonZeroU128> for NonZeroU8
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroU8
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroU128> for NonZeroUsize
impl TryFrom<NonZeroU128> for NonZeroUsize
source§fn try_from(
value: NonZeroU128
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroU128>>::Error>
fn try_from( value: NonZeroU128 ) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroU128>>::Error>
Attempts to convert NonZeroU128
to NonZeroUsize
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroUsize> for NonZeroU128
impl TryFrom<NonZeroUsize> for NonZeroU128
source§fn try_from(
value: NonZeroUsize
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroUsize>>::Error>
fn try_from( value: NonZeroUsize ) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroUsize>>::Error>
Attempts to convert NonZeroUsize
to NonZeroU128
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.46.0 · source§impl TryFrom<u128> for NonZeroU128
impl TryFrom<u128> for NonZeroU128
source§fn try_from(
value: u128
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<u128>>::Error>
fn try_from( value: u128 ) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<u128>>::Error>
Attempts to convert u128
to NonZeroU128
.