Struct std::num::NonZeroU16

1.28.0 · source ·
pub struct NonZeroU16(_);
Expand description

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>());
Run

Implementations§

source§

impl NonZeroU16

const: 1.28.0 · source

pub const unsafe fn new_unchecked(n: u16) -> NonZeroU16

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 · source

pub const fn new(n: u16) -> Option<NonZeroU16>

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

const: 1.34.0 · source

pub const fn get(self) -> u16

Returns the value as a primitive type.

source§

impl NonZeroU16

1.53.0 (const: 1.53.0) · source

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::NonZeroU16::new(u16::MAX).unwrap();

assert_eq!(n.leading_zeros(), 0);
Run
1.53.0 (const: 1.53.0) · source

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::NonZeroU16::new(0b0101000).unwrap();

assert_eq!(n.trailing_zeros(), 3);
Run
source§

impl NonZeroU16

1.64.0 (const: 1.64.0) · source

pub const fn checked_add(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));
Run
1.64.0 (const: 1.64.0) · source

pub const fn saturating_add(self, other: u16) -> NonZeroU16

Adds an unsigned integer to a non-zero value. Return u16::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));
Run
source

pub const unsafe fn unchecked_add(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) });
Run
1.64.0 (const: 1.64.0) · source

pub const fn checked_next_power_of_two(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() );
Run
1.67.0 (const: 1.67.0) · source

pub const fn ilog2(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);
Run
1.67.0 (const: 1.67.0) · source

pub const fn ilog10(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);
Run
source§

impl NonZeroU16

1.64.0 (const: 1.64.0) · source

pub const fn checked_mul(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));
Run
1.64.0 (const: 1.64.0) · source

pub const fn saturating_mul(self, other: NonZeroU16) -> NonZeroU16

Multiplies two non-zero integers together. Return u16::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));
Run
source

pub const unsafe fn unchecked_mul(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) });
Run
1.64.0 (const: 1.64.0) · source

pub const fn checked_pow(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));
Run
1.64.0 (const: 1.64.0) · source

pub const fn saturating_pow(self, other: u32) -> NonZeroU16

Raise non-zero value to an integer power. Return u16::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));
Run
source§

impl NonZeroU16

1.59.0 (const: 1.59.0) · source

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::NonZeroU16::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroU16::new(10).unwrap();
assert!(!ten.is_power_of_two());
Run
source§

impl NonZeroU16

source

pub const MIN: NonZeroU16 = Self::new(1).unwrap()

🔬This is a nightly-only experimental API. (nonzero_min_max #89065)

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

Examples
#![feature(nonzero_min_max)]

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

pub const MAX: NonZeroU16 = Self::new(u16::MAX).unwrap()

🔬This is a nightly-only experimental API. (nonzero_min_max #89065)

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

Examples
#![feature(nonzero_min_max)]

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

impl NonZeroU16

1.67.0 · source

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);
Run

Trait Implementations§

source§

impl Binary for NonZeroU16

source§

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

Formats the value using the given formatter.
1.45.0 (const: unstable) · source§

impl BitOr<NonZeroU16> for NonZeroU16

§

type Output = NonZeroU16

The resulting type after applying the | operator.
const: unstable · source§

fn bitor(self, rhs: NonZeroU16) -> <NonZeroU16 as BitOr<NonZeroU16>>::Output

Performs the | operation. Read more
1.45.0 (const: unstable) · source§

impl BitOr<NonZeroU16> for u16

§

type Output = NonZeroU16

The resulting type after applying the | operator.
const: unstable · source§

fn bitor(self, rhs: NonZeroU16) -> <u16 as BitOr<NonZeroU16>>::Output

Performs the | operation. Read more
1.45.0 (const: unstable) · source§

impl BitOr<u16> for NonZeroU16

§

type Output = NonZeroU16

The resulting type after applying the | operator.
const: unstable · source§

fn bitor(self, rhs: u16) -> <NonZeroU16 as BitOr<u16>>::Output

Performs the | operation. Read more
1.45.0 (const: unstable) · source§

impl BitOrAssign<NonZeroU16> for NonZeroU16

const: unstable · source§

fn bitor_assign(&mut self, rhs: NonZeroU16)

Performs the |= operation. Read more
1.45.0 (const: unstable) · source§

impl BitOrAssign<u16> for NonZeroU16

const: unstable · source§

fn bitor_assign(&mut self, rhs: u16)

Performs the |= operation. Read more
source§

impl Clone for NonZeroU16

source§

fn clone(&self) -> NonZeroU16

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for NonZeroU16

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for NonZeroU16

source§

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

Formats the value using the given formatter. Read more
1.51.0 (const: unstable) · source§

impl Div<NonZeroU16> for u16

const: unstable · source§

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.
1.41.0 (const: unstable) · source§

impl From<NonZeroU16> for NonZeroI128

const: unstable · source§

fn from(small: NonZeroU16) -> NonZeroI128

Converts NonZeroU16 to NonZeroI128 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU16> for NonZeroI32

const: unstable · source§

fn from(small: NonZeroU16) -> NonZeroI32

Converts NonZeroU16 to NonZeroI32 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU16> for NonZeroI64

const: unstable · source§

fn from(small: NonZeroU16) -> NonZeroI64

Converts NonZeroU16 to NonZeroI64 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU16> for NonZeroU128

const: unstable · source§

fn from(small: NonZeroU16) -> NonZeroU128

Converts NonZeroU16 to NonZeroU128 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU16> for NonZeroU32

const: unstable · source§

fn from(small: NonZeroU16) -> NonZeroU32

Converts NonZeroU16 to NonZeroU32 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU16> for NonZeroU64

const: unstable · source§

fn from(small: NonZeroU16) -> NonZeroU64

Converts NonZeroU16 to NonZeroU64 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU16> for NonZeroUsize

const: unstable · source§

fn from(small: NonZeroU16) -> NonZeroUsize

Converts NonZeroU16 to NonZeroUsize losslessly.

1.31.0 (const: unstable) · source§

impl From<NonZeroU16> for u16

const: unstable · source§

fn from(nonzero: NonZeroU16) -> u16

Converts a NonZeroU16 into an u16

1.41.0 (const: unstable) · source§

impl From<NonZeroU8> for NonZeroU16

const: unstable · source§

fn from(small: NonZeroU8) -> NonZeroU16

Converts NonZeroU8 to NonZeroU16 losslessly.

1.35.0 · source§

impl FromStr for NonZeroU16

§

type Err = ParseIntError

The associated error which can be returned from parsing.
source§

fn from_str(src: &str) -> Result<NonZeroU16, <NonZeroU16 as FromStr>::Err>

Parses a string s to return a value of this type. Read more
source§

impl Hash for NonZeroU16

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl LowerHex for NonZeroU16

source§

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

Formats the value using the given formatter.
source§

impl Octal for NonZeroU16

source§

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

Formats the value using the given formatter.
source§

impl Ord for NonZeroU16

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq<NonZeroU16> for NonZeroU16

source§

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

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

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.
source§

impl PartialOrd<NonZeroU16> for NonZeroU16

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
1.51.0 (const: unstable) · source§

impl Rem<NonZeroU16> for u16

const: unstable · source§

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.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroU16

source§

fn try_from(
    value: NonZeroI128
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI128>>::Error>

Attempts to convert NonZeroI128 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI16> for NonZeroU16

source§

fn try_from(
    value: NonZeroI16
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI16>>::Error>

Attempts to convert NonZeroI16 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI32> for NonZeroU16

source§

fn try_from(
    value: NonZeroI32
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI32>>::Error>

Attempts to convert NonZeroI32 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI64> for NonZeroU16

source§

fn try_from(
    value: NonZeroI64
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI64>>::Error>

Attempts to convert NonZeroI64 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI8> for NonZeroU16

source§

fn try_from(
    value: NonZeroI8
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI8>>::Error>

Attempts to convert NonZeroI8 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroIsize> for NonZeroU16

source§

fn try_from(
    value: NonZeroIsize
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroIsize>>::Error>

Attempts to convert NonZeroIsize to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroU128> for NonZeroU16

source§

fn try_from(
    value: NonZeroU128
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroU128>>::Error>

Attempts to convert NonZeroU128 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroU16> for NonZeroI16

source§

fn try_from(
    value: NonZeroU16
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU16>>::Error>

Attempts to convert NonZeroU16 to NonZeroI16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroU16> for NonZeroI8

source§

fn try_from(
    value: NonZeroU16
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroU16>>::Error>

Attempts to convert NonZeroU16 to NonZeroI8.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroU16> for NonZeroIsize

source§

fn try_from(
    value: NonZeroU16
) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroU16>>::Error>

Attempts to convert NonZeroU16 to NonZeroIsize.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroU16> for NonZeroU8

source§

fn try_from(
    value: NonZeroU16
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroU16>>::Error>

Attempts to convert NonZeroU16 to NonZeroU8.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroU32> for NonZeroU16

source§

fn try_from(
    value: NonZeroU32
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroU32>>::Error>

Attempts to convert NonZeroU32 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroU64> for NonZeroU16

source§

fn try_from(
    value: NonZeroU64
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroU64>>::Error>

Attempts to convert NonZeroU64 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroUsize> for NonZeroU16

source§

fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroUsize>>::Error>

Attempts to convert NonZeroUsize to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.46.0 · source§

impl TryFrom<u16> for NonZeroU16

source§

fn try_from(
    value: u16
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<u16>>::Error>

Attempts to convert u16 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

impl UpperHex for NonZeroU16

source§

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

Formats the value using the given formatter.
source§

impl Copy for NonZeroU16

source§

impl Eq for NonZeroU16

source§

impl StructuralEq for NonZeroU16

source§

impl StructuralPartialEq for NonZeroU16

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere
    T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere
    T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere
    T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.