Type Alias core::ffi::NonZero_c_ulong
source · pub type NonZero_c_ulong = NonZeroU64;
raw_os_nonzero
#82363)Expand description
Type alias for NonZero
version of c_ulong
Aliased Type§
struct NonZero_c_ulong(/* private fields */);
Implementations§
source§impl NonZeroU64
impl NonZeroU64
1.28.0 (const: 1.28.0) · sourcepub const unsafe fn new_unchecked(n: u64) -> Self
pub const unsafe fn new_unchecked(n: u64) -> 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 NonZeroU64
impl NonZeroU64
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::NonZeroU64::new(u64::MAX).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::NonZeroU64::new(0b0101000).unwrap();
assert_eq!(n.trailing_zeros(), 3);
Runsource§impl NonZeroU64
impl NonZeroU64
1.64.0 (const: 1.64.0) · sourcepub const fn checked_add(self, other: u64) -> Option<NonZeroU64>
pub const fn checked_add(self, other: u64) -> Option<NonZeroU64>
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 = NonZeroU64::new(1)?;
let two = NonZeroU64::new(2)?;
let max = NonZeroU64::new(u64::MAX)?;
assert_eq!(Some(two), one.checked_add(1));
assert_eq!(None, max.checked_add(1));
Run1.64.0 (const: 1.64.0) · sourcepub const fn saturating_add(self, other: u64) -> NonZeroU64
pub const fn saturating_add(self, other: u64) -> NonZeroU64
Adds an unsigned integer to a non-zero value.
Return NonZeroU64::MAX
on overflow.
Examples
let one = NonZeroU64::new(1)?;
let two = NonZeroU64::new(2)?;
let max = NonZeroU64::new(u64::MAX)?;
assert_eq!(two, one.saturating_add(1));
assert_eq!(max, max.saturating_add(1));
Runsourcepub const unsafe fn unchecked_add(self, other: u64) -> NonZeroU64
🔬This is a nightly-only experimental API. (nonzero_ops
#84186)
pub const unsafe fn unchecked_add(self, other: u64) -> NonZeroU64
nonzero_ops
#84186)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 > u64::MAX
.
Examples
#![feature(nonzero_ops)]
let one = NonZeroU64::new(1)?;
let two = NonZeroU64::new(2)?;
assert_eq!(two, unsafe { one.unchecked_add(1) });
Run1.64.0 (const: 1.64.0) · sourcepub const fn checked_next_power_of_two(self) -> Option<NonZeroU64>
pub const fn checked_next_power_of_two(self) -> Option<NonZeroU64>
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 = NonZeroU64::new(2)?;
let three = NonZeroU64::new(3)?;
let four = NonZeroU64::new(4)?;
let max = NonZeroU64::new(u64::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() );
Run1.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
u64::ilog2
,
except that it has no failure cases to worry about
since this value can never be zero.
Examples
assert_eq!(NonZeroU64::new(7).unwrap().ilog2(), 2);
assert_eq!(NonZeroU64::new(8).unwrap().ilog2(), 3);
assert_eq!(NonZeroU64::new(9).unwrap().ilog2(), 3);
Run1.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
u64::ilog10
,
except that it has no failure cases to worry about
since this value can never be zero.
Examples
assert_eq!(NonZeroU64::new(99).unwrap().ilog10(), 1);
assert_eq!(NonZeroU64::new(100).unwrap().ilog10(), 2);
assert_eq!(NonZeroU64::new(101).unwrap().ilog10(), 2);
Runconst: unstable · sourcepub fn midpoint(self, rhs: Self) -> Self
🔬This is a nightly-only experimental API. (num_midpoint
#110840)
pub fn midpoint(self, rhs: Self) -> Self
num_midpoint
#110840)Calculates the middle point of self
and rhs
.
midpoint(a, b)
is (a + b) >> 1
as if it were performed in a
sufficiently-large signed integral type. This implies that the result is
always rounded towards negative infinity and that no overflow will ever occur.
Examples
#![feature(num_midpoint)]
let one = NonZeroU64::new(1)?;
let two = NonZeroU64::new(2)?;
let four = NonZeroU64::new(4)?;
assert_eq!(one.midpoint(four), two);
assert_eq!(four.midpoint(one), two);
Runsource§impl NonZeroU64
impl NonZeroU64
1.64.0 (const: 1.64.0) · sourcepub const fn checked_mul(self, other: NonZeroU64) -> Option<NonZeroU64>
pub const fn checked_mul(self, other: NonZeroU64) -> Option<NonZeroU64>
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 = NonZeroU64::new(2)?;
let four = NonZeroU64::new(4)?;
let max = NonZeroU64::new(u64::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: NonZeroU64) -> NonZeroU64
pub const fn saturating_mul(self, other: NonZeroU64) -> NonZeroU64
Multiplies two non-zero integers together.
Return NonZeroU64::MAX
on overflow.
Examples
let two = NonZeroU64::new(2)?;
let four = NonZeroU64::new(4)?;
let max = NonZeroU64::new(u64::MAX)?;
assert_eq!(four, two.saturating_mul(two));
assert_eq!(max, four.saturating_mul(max));
Runsourcepub const unsafe fn unchecked_mul(self, other: NonZeroU64) -> NonZeroU64
🔬This is a nightly-only experimental API. (nonzero_ops
#84186)
pub const unsafe fn unchecked_mul(self, other: NonZeroU64) -> NonZeroU64
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 > u64::MAX
.
Examples
#![feature(nonzero_ops)]
let two = NonZeroU64::new(2)?;
let four = NonZeroU64::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<NonZeroU64>
pub const fn checked_pow(self, other: u32) -> Option<NonZeroU64>
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 = NonZeroU64::new(3)?;
let twenty_seven = NonZeroU64::new(27)?;
let half_max = NonZeroU64::new(u64::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) -> NonZeroU64
pub const fn saturating_pow(self, other: u32) -> NonZeroU64
Raise non-zero value to an integer power.
Return NonZeroU64::MAX
on overflow.
Examples
let three = NonZeroU64::new(3)?;
let twenty_seven = NonZeroU64::new(27)?;
let max = NonZeroU64::new(u64::MAX)?;
assert_eq!(twenty_seven, three.saturating_pow(3));
assert_eq!(max, max.saturating_pow(3));
Runsource§impl NonZeroU64
impl NonZeroU64
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::NonZeroU64::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroU64::new(10).unwrap();
assert!(!ten.is_power_of_two());
Runsource§impl NonZeroU64
impl NonZeroU64
Trait Implementations§
1.28.0 · source§impl Binary for NonZeroU64
impl Binary for NonZeroU64
1.45.0 · source§impl BitOr<NonZeroU64> for NonZeroU64
impl BitOr<NonZeroU64> for NonZeroU64
1.45.0 · source§impl BitOr<u64> for NonZeroU64
impl BitOr<u64> for NonZeroU64
1.45.0 · source§impl BitOrAssign<NonZeroU64> for NonZeroU64
impl BitOrAssign<NonZeroU64> for NonZeroU64
source§fn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
|=
operation. Read more1.45.0 · source§impl BitOrAssign<u64> for NonZeroU64
impl BitOrAssign<u64> for NonZeroU64
source§fn bitor_assign(&mut self, rhs: u64)
fn bitor_assign(&mut self, rhs: u64)
|=
operation. Read more1.28.0 · source§impl Clone for NonZeroU64
impl Clone for NonZeroU64
source§fn clone(&self) -> NonZeroU64
fn clone(&self) -> NonZeroU64
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more1.28.0 · source§impl Debug for NonZeroU64
impl Debug for NonZeroU64
1.28.0 · source§impl Display for NonZeroU64
impl Display for NonZeroU64
1.41.0 · source§impl From<NonZeroU16> for NonZeroU64
impl From<NonZeroU16> for NonZeroU64
source§fn from(small: NonZeroU16) -> Self
fn from(small: NonZeroU16) -> Self
Converts NonZeroU16
to NonZeroU64
losslessly.
1.41.0 · source§impl From<NonZeroU32> for NonZeroU64
impl From<NonZeroU32> for NonZeroU64
source§fn from(small: NonZeroU32) -> Self
fn from(small: NonZeroU32) -> Self
Converts NonZeroU32
to NonZeroU64
losslessly.
1.41.0 · source§impl From<NonZeroU8> for NonZeroU64
impl From<NonZeroU8> for NonZeroU64
1.35.0 · source§impl FromStr for NonZeroU64
impl FromStr for NonZeroU64
1.28.0 · source§impl Hash for NonZeroU64
impl Hash for NonZeroU64
1.28.0 · source§impl LowerHex for NonZeroU64
impl LowerHex for NonZeroU64
1.28.0 · source§impl Octal for NonZeroU64
impl Octal for NonZeroU64
1.28.0 · source§impl Ord for NonZeroU64
impl Ord for NonZeroU64
source§fn cmp(&self, other: &NonZeroU64) -> Ordering
fn cmp(&self, other: &NonZeroU64) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
1.28.0 · source§impl PartialEq<NonZeroU64> for NonZeroU64
impl PartialEq<NonZeroU64> for NonZeroU64
source§fn eq(&self, other: &NonZeroU64) -> bool
fn eq(&self, other: &NonZeroU64) -> bool
self
and other
values to be equal, and is used
by ==
.1.28.0 · source§impl PartialOrd<NonZeroU64> for NonZeroU64
impl PartialOrd<NonZeroU64> for NonZeroU64
source§fn partial_cmp(&self, other: &NonZeroU64) -> Option<Ordering>
fn partial_cmp(&self, other: &NonZeroU64) -> 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 NonZeroU64
impl TryFrom<NonZeroI128> for NonZeroU64
source§fn 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 · source§impl TryFrom<NonZeroI16> for NonZeroU64
impl TryFrom<NonZeroI16> for NonZeroU64
source§fn try_from(value: NonZeroI16) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI16) -> Result<Self, Self::Error>
Attempts to convert NonZeroI16
to NonZeroU64
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroI32> for NonZeroU64
impl TryFrom<NonZeroI32> for NonZeroU64
source§fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>
Attempts to convert NonZeroI32
to NonZeroU64
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroI64> for NonZeroU64
impl TryFrom<NonZeroI64> for NonZeroU64
source§fn try_from(value: NonZeroI64) -> Result<Self, Self::Error>
fn try_from(value: NonZeroI64) -> Result<Self, Self::Error>
Attempts to convert NonZeroI64
to NonZeroU64
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroI8> for NonZeroU64
impl TryFrom<NonZeroI8> for NonZeroU64
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<NonZeroU128> for NonZeroU64
impl TryFrom<NonZeroU128> for NonZeroU64
source§fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>
fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>
Attempts to convert NonZeroU128
to NonZeroU64
.
§type Error = TryFromIntError
type Error = TryFromIntError
1.49.0 · source§impl TryFrom<NonZeroUsize> for NonZeroU64
impl TryFrom<NonZeroUsize> for NonZeroU64
source§fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>
Attempts to convert NonZeroUsize
to NonZeroU64
.