Struct core::num::NonZeroU16

#[repr(transparent)]
pub struct NonZeroU16(/* private fields */);

An integer that is known not to equal zero.

This enables some memory layout optimization. For example, Option<NonZeroU16> is the same size as u16:

use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroU16>>(), size_of::<u16>());

Layout

NonZeroU16 is guaranteed to have the same layout and bit validity as u16 with the exception that 0 is not a valid instance. Option<NonZeroU16> is guaranteed to be compatible with u16, including in FFI.

Thanks to the null pointer optimization, NonZeroU16 and Option<NonZeroU16> are guaranteed to have the same size and alignment:

use std::num::NonZeroU16;

assert_eq!(size_of::<NonZeroU16>(), size_of::<Option<NonZeroU16>>());
assert_eq!(align_of::<NonZeroU16>(), align_of::<Option<NonZeroU16>>());

Implementations

impl NonZeroU16

pub const unsafe fn new_unchecked<const host: bool = true>(n: u16) -> 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.

pub const fn new<const host: bool = true>(n: u16) -> Option<Self>

Creates a non-zero if the given value is not zero.

pub const fn get<const host: bool = true>(self) -> u16

Returns the value as a primitive type.

impl NonZeroU16

pub const fn leading_zeros<const host: bool = true>(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::NonZeroU16::new(u16::MAX).unwrap();

assert_eq!(n.leading_zeros(), 0);

pub const fn trailing_zeros<const host: bool = true>(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::NonZeroU16::new(0b0101000).unwrap();

assert_eq!(n.trailing_zeros(), 3);

impl NonZeroU16

pub const fn checked_add<const host: bool = true>( self, other: u16 ) -> Option<NonZeroU16>

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 = NonZeroU16::new(1)?;
let two = NonZeroU16::new(2)?;
let max = NonZeroU16::new(u16::MAX)?;

assert_eq!(Some(two), one.checked_add(1));
assert_eq!(None, max.checked_add(1));

pub const fn saturating_add<const host: bool = true>( self, other: u16 ) -> NonZeroU16

Adds an unsigned integer to a non-zero value. Return NonZeroU16::MAX on overflow.

Examples

let one = NonZeroU16::new(1)?;
let two = NonZeroU16::new(2)?;
let max = NonZeroU16::new(u16::MAX)?;

assert_eq!(two, one.saturating_add(1));
assert_eq!(max, max.saturating_add(1));

pub const unsafe fn unchecked_add<const host: bool = true>( self, other: u16 ) -> NonZeroU16

🔬This is a nightly-only experimental API. (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 > u16::MAX.

Examples

#![feature(nonzero_ops)]

let one = NonZeroU16::new(1)?;
let two = NonZeroU16::new(2)?;

assert_eq!(two, unsafe { one.unchecked_add(1) });

pub const fn checked_next_power_of_two<const host: bool = true>( self ) -> Option<NonZeroU16>

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 = NonZeroU16::new(2)?;
let three = NonZeroU16::new(3)?;
let four = NonZeroU16::new(4)?;
let max = NonZeroU16::new(u16::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() );

pub const fn ilog2<const host: bool = true>(self) -> u32

Returns the base 2 logarithm of the number, rounded down.

This is the same operation as u16::ilog2, except that it has no failure cases to worry about since this value can never be zero.

Examples

assert_eq!(NonZeroU16::new(7).unwrap().ilog2(), 2);
assert_eq!(NonZeroU16::new(8).unwrap().ilog2(), 3);
assert_eq!(NonZeroU16::new(9).unwrap().ilog2(), 3);

pub const fn ilog10<const host: bool = true>(self) -> u32

Returns the base 10 logarithm of the number, rounded down.

This is the same operation as u16::ilog10, except that it has no failure cases to worry about since this value can never be zero.

Examples

assert_eq!(NonZeroU16::new(99).unwrap().ilog10(), 1);
assert_eq!(NonZeroU16::new(100).unwrap().ilog10(), 2);
assert_eq!(NonZeroU16::new(101).unwrap().ilog10(), 2);

pub fn midpoint<const host: bool = true>(self, rhs: Self) -> Self

🔬This is a nightly-only experimental API. (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 = NonZeroU16::new(1)?;
let two = NonZeroU16::new(2)?;
let four = NonZeroU16::new(4)?;

assert_eq!(one.midpoint(four), two);
assert_eq!(four.midpoint(one), two);

impl NonZeroU16

pub const fn checked_mul<const host: bool = true>( self, other: NonZeroU16 ) -> Option<NonZeroU16>

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 = NonZeroU16::new(2)?;
let four = NonZeroU16::new(4)?;
let max = NonZeroU16::new(u16::MAX)?;

assert_eq!(Some(four), two.checked_mul(two));
assert_eq!(None, max.checked_mul(two));

pub const fn saturating_mul<const host: bool = true>( self, other: NonZeroU16 ) -> NonZeroU16

Multiplies two non-zero integers together. Return NonZeroU16::MAX on overflow.

Examples

let two = NonZeroU16::new(2)?;
let four = NonZeroU16::new(4)?;
let max = NonZeroU16::new(u16::MAX)?;

assert_eq!(four, two.saturating_mul(two));
assert_eq!(max, four.saturating_mul(max));

pub const unsafe fn unchecked_mul<const host: bool = true>( self, other: NonZeroU16 ) -> NonZeroU16

🔬This is a nightly-only experimental API. (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 > u16::MAX.

Examples

#![feature(nonzero_ops)]

let two = NonZeroU16::new(2)?;
let four = NonZeroU16::new(4)?;

assert_eq!(four, unsafe { two.unchecked_mul(two) });

pub const fn checked_pow<const host: bool = true>( self, other: u32 ) -> Option<NonZeroU16>

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 = NonZeroU16::new(3)?;
let twenty_seven = NonZeroU16::new(27)?;
let half_max = NonZeroU16::new(u16::MAX / 2)?;

assert_eq!(Some(twenty_seven), three.checked_pow(3));
assert_eq!(None, half_max.checked_pow(3));

pub const fn saturating_pow<const host: bool = true>( self, other: u32 ) -> NonZeroU16

Raise non-zero value to an integer power. Return NonZeroU16::MAX on overflow.

Examples

let three = NonZeroU16::new(3)?;
let twenty_seven = NonZeroU16::new(27)?;
let max = NonZeroU16::new(u16::MAX)?;

assert_eq!(twenty_seven, three.saturating_pow(3));
assert_eq!(max, max.saturating_pow(3));

impl NonZeroU16

pub const fn is_power_of_two<const host: bool = true>(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::NonZeroU16::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroU16::new(10).unwrap();
assert!(!ten.is_power_of_two());

impl NonZeroU16

pub const MIN: Self = _

The smallest value that can be represented by this non-zero integer type, 1.

Examples

assert_eq!(NonZeroU16::MIN.get(), 1u16);

pub const MAX: Self = _

The largest value that can be represented by this non-zero integer type, equal to u16::MAX.

Examples

assert_eq!(NonZeroU16::MAX.get(), u16::MAX);

impl NonZeroU16

pub const BITS: u32 = 16u32

The size of this non-zero integer type in bits.

This value is equal to u16::BITS.

Examples

assert_eq!(NonZeroU16::BITS, u16::BITS);

Trait Implementations

impl Binary for NonZeroU16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitOr<NonZeroU16> for u16

type Output = NonZeroU16

The resulting type after applying the | operator.

fn bitor(self, rhs: NonZeroU16) -> Self::Output

Performs the | operation.

impl BitOr<u16> for NonZeroU16

type Output = NonZeroU16

The resulting type after applying the | operator.

fn bitor(self, rhs: u16) -> Self::Output

Performs the | operation.

impl BitOr<NonZeroU16> for NonZeroU16

type Output = NonZeroU16

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign<u16> for NonZeroU16

fn bitor_assign(&mut self, rhs: u16)

Performs the |= operation.

impl BitOrAssign<NonZeroU16> for NonZeroU16

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for NonZeroU16

fn clone(&self) -> NonZeroU16

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NonZeroU16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for NonZeroU16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Div<NonZeroU16> for u16

fn div(self, other: NonZeroU16) -> u16

This operation rounds towards zero, truncating any fractional part of the exact result, and cannot panic.

type Output = u16

The resulting type after applying the / operator.

impl From<NonZeroU16> for NonZeroI128

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroI128 losslessly.

impl From<NonZeroU16> for NonZeroI32

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroI32 losslessly.

impl From<NonZeroU16> for NonZeroI64

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroI64 losslessly.

impl From<NonZeroU16> for NonZeroU128

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroU128 losslessly.

impl From<NonZeroU16> for NonZeroU32

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroU32 losslessly.

impl From<NonZeroU16> for NonZeroU64

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroU64 losslessly.

impl From<NonZeroU16> for NonZeroUsize

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroUsize losslessly.

impl From<NonZeroU16> for u16

fn from(nonzero: NonZeroU16) -> Self

Converts a NonZeroU16 into an u16

impl From<NonZeroU8> for NonZeroU16

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroU16 losslessly.

impl FromStr for NonZeroU16

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for NonZeroU16

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H: Hasher>(data: &[Self], state: &mut H)where Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for NonZeroU16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Octal for NonZeroU16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for NonZeroU16

fn cmp(&self, other: &NonZeroU16) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<NonZeroU16> for NonZeroU16

fn eq(&self, other: &NonZeroU16) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<NonZeroU16> for NonZeroU16

fn partial_cmp(&self, other: &NonZeroU16) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem<NonZeroU16> for u16

fn rem(self, other: NonZeroU16) -> u16

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

type Output = u16

The resulting type after applying the % operator.

impl TryFrom<NonZeroI128> for NonZeroU16

fn try_from(value: NonZeroI128) -> Result<Self, Self::Error>

Attempts to convert NonZeroI128 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI16> for NonZeroU16

fn try_from(value: NonZeroI16) -> Result<Self, Self::Error>

Attempts to convert NonZeroI16 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU16

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroU16

fn try_from(value: NonZeroI64) -> Result<Self, Self::Error>

Attempts to convert NonZeroI64 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI8> for NonZeroU16

fn try_from(value: NonZeroI8) -> Result<Self, Self::Error>

Attempts to convert NonZeroI8 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroIsize> for NonZeroU16

fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>

Attempts to convert NonZeroIsize to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroU16

fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert NonZeroU128 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU16> for NonZeroI16

fn try_from(value: NonZeroU16) -> Result<Self, Self::Error>

Attempts to convert NonZeroU16 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU16> for NonZeroI8

fn try_from(value: NonZeroU16) -> Result<Self, Self::Error>

Attempts to convert NonZeroU16 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU16> for NonZeroIsize

fn try_from(value: NonZeroU16) -> Result<Self, Self::Error>

Attempts to convert NonZeroU16 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU16> for NonZeroU8

fn try_from(value: NonZeroU16) -> Result<Self, Self::Error>

Attempts to convert NonZeroU16 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU32> for NonZeroU16

fn try_from(value: NonZeroU32) -> Result<Self, Self::Error>

Attempts to convert NonZeroU32 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU64> for NonZeroU16

fn try_from(value: NonZeroU64) -> Result<Self, Self::Error>

Attempts to convert NonZeroU64 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroUsize> for NonZeroU16

fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>

Attempts to convert NonZeroUsize to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<u16> for NonZeroU16

fn try_from(value: u16) -> Result<Self, Self::Error>

Attempts to convert u16 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl UpperHex for NonZeroU16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for NonZeroU16

impl Eq for NonZeroU16

impl StructuralEq for NonZeroU16

impl StructuralPartialEq for NonZeroU16