std::num::NonZeroU16 - Rust
Description: API documentation for the Rust `NonZeroU16` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, NonZeroU16

# 1.28.0[−][src]Struct std::num::NonZeroU16

    #[repr(transparent)]pub struct NonZeroU16(_);

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

### `impl NonZeroU16`[src]

#### `pub const unsafe fn new_unchecked(n: u16) -> NonZeroU16`[src]

Creates a non-zero without checking the value.

# Safety

The value must not be zero.

#### `pub const fn new(n: u16) -> Option<NonZeroU16>`[src]

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

#### `pub const fn get(self) -> u16`[src]

Returns the value as a primitive type.

## Trait Implementations

### `impl Binary for NonZeroU16`[src]

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter.

### `impl BitOr<NonZeroU16> for u16` 1.45.0[src]

#### `type Output = NonZeroU16`

The resulting type after applying the `|` operator.

#### `pub fn bitor(self, rhs: NonZeroU16) -> <u16 as BitOr<NonZeroU16>>::Output`[src]

Performs the `|` operation. Read more

### `impl BitOr<NonZeroU16> for NonZeroU16` 1.45.0[src]

#### `type Output = NonZeroU16`

The resulting type after applying the `|` operator.

#### `pub fn bitor(self, rhs: NonZeroU16) -> <NonZeroU16 as BitOr<NonZeroU16>>::Output`[src]

Performs the `|` operation. Read more

### `impl BitOr<u16> for NonZeroU16` 1.45.0[src]

#### `type Output = NonZeroU16`

The resulting type after applying the `|` operator.

#### `pub fn bitor(self, rhs: u16) -> <NonZeroU16 as BitOr<u16>>::Output`[src]

Performs the `|` operation. Read more

### `impl BitOrAssign<NonZeroU16> for NonZeroU16` 1.45.0[src]

#### `pub fn bitor_assign(&mut self, rhs: NonZeroU16)`[src]

Performs the `|=` operation. Read more

### `impl BitOrAssign<u16> for NonZeroU16` 1.45.0[src]

#### `pub fn bitor_assign(&mut self, rhs: u16)`[src]

Performs the `|=` operation. Read more

### `impl Clone for NonZeroU16`[src]

#### `pub fn clone(&self) -> NonZeroU16`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

### `impl Copy for NonZeroU16`[src]

### `impl Debug for NonZeroU16`[src]

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

### `impl Display for NonZeroU16`[src]

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

### `impl Eq for NonZeroU16`[src]

### `impl From<NonZeroU16> for NonZeroUsize` 1.41.0[src]

Converts `NonZeroU16` to `NonZeroUsize` losslessly.

#### `pub fn from(small: NonZeroU16) -> NonZeroUsize`[src]

Performs the conversion.

### `impl From<NonZeroU16> for NonZeroU128` 1.41.0[src]

Converts `NonZeroU16` to `NonZeroU128` losslessly.

#### `pub fn from(small: NonZeroU16) -> NonZeroU128`[src]

Performs the conversion.

### `impl From<NonZeroU16> for NonZeroI64` 1.41.0[src]

Converts `NonZeroU16` to `NonZeroI64` losslessly.

#### `pub fn from(small: NonZeroU16) -> NonZeroI64`[src]

Performs the conversion.

### `impl From<NonZeroU16> for NonZeroU64` 1.41.0[src]

Converts `NonZeroU16` to `NonZeroU64` losslessly.

#### `pub fn from(small: NonZeroU16) -> NonZeroU64`[src]

Performs the conversion.

### `impl From<NonZeroU16> for u16` 1.31.0[src]

#### `pub fn from(nonzero: NonZeroU16) -> u16`[src]

Converts a `NonZeroU16` into an `u16`

### `impl From<NonZeroU16> for NonZeroU32` 1.41.0[src]

Converts `NonZeroU16` to `NonZeroU32` losslessly.

#### `pub fn from(small: NonZeroU16) -> NonZeroU32`[src]

Performs the conversion.

### `impl From<NonZeroU16> for NonZeroI32` 1.41.0[src]

Converts `NonZeroU16` to `NonZeroI32` losslessly.

#### `pub fn from(small: NonZeroU16) -> NonZeroI32`[src]

Performs the conversion.

### `impl From<NonZeroU16> for NonZeroI128` 1.41.0[src]

Converts `NonZeroU16` to `NonZeroI128` losslessly.

#### `pub fn from(small: NonZeroU16) -> NonZeroI128`[src]

Performs the conversion.

### `impl From<NonZeroU8> for NonZeroU16` 1.41.0[src]

Converts `NonZeroU8` to `NonZeroU16` losslessly.

#### `pub fn from(small: NonZeroU8) -> NonZeroU16`[src]

Performs the conversion.

### `impl FromStr for NonZeroU16` 1.35.0[src]

#### `type Err = ParseIntError`

The associated error which can be returned from parsing.

#### `pub fn from_str(src: &str) -> Result<NonZeroU16, <NonZeroU16 as FromStr>::Err>`[src]

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

### `impl Hash for NonZeroU16`[src]

#### `pub fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,` [src]

Feeds this value into the given `Hasher`. Read more

#### `fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0[src]

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

### `impl LowerHex for NonZeroU16`[src]

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter.

### `impl Octal for NonZeroU16`[src]

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter.

### `impl Ord for NonZeroU16`[src]

#### `pub fn cmp(&self, other: &NonZeroU16) -> Ordering`[src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `#[must_use]fn max(self, other: Self) -> Self`1.21.0[src]

Compares and returns the maximum of two values. Read more

#### `#[must_use]fn min(self, other: Self) -> Self`1.21.0[src]

Compares and returns the minimum of two values. Read more

#### `#[must_use]fn clamp(self, min: Self, max: Self) -> Self`[src]

🔬 This is a nightly-only experimental API. (`clamp` #44095)

Restrict a value to a certain interval. Read more

### `impl PartialEq<NonZeroU16> for NonZeroU16`[src]

#### `pub fn eq(&self, other: &NonZeroU16) -> bool`[src]

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

#### `pub fn ne(&self, other: &NonZeroU16) -> bool`[src]

This method tests for `!=`.

### `impl PartialOrd<NonZeroU16> for NonZeroU16`[src]

#### `pub fn partial_cmp(&self, other: &NonZeroU16) -> Option<Ordering>`[src]

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

#### `pub fn lt(&self, other: &NonZeroU16) -> bool`[src]

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

#### `pub fn le(&self, other: &NonZeroU16) -> bool`[src]

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

#### `pub fn gt(&self, other: &NonZeroU16) -> bool`[src]

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

#### `pub fn ge(&self, other: &NonZeroU16) -> bool`[src]

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

### `impl StructuralEq for NonZeroU16`[src]

### `impl StructuralPartialEq for NonZeroU16`[src]

### `impl TryFrom<NonZeroI128> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroI128` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroI128
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI128>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroI16> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroI16` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI16>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroI32> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroI32` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroI32
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI32>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroI64> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroI64` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI64>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroI8> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroI8` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroI8
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroI8>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroIsize> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroIsize` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroIsize
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroIsize>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroU128> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroU128` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroU128
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroU128>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroU16> for NonZeroIsize` 1.49.0[src]

Attempts to convert `NonZeroU16` to `NonZeroIsize`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroU16
) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroU16>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroU16> for NonZeroI8` 1.49.0[src]

Attempts to convert `NonZeroU16` to `NonZeroI8`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroU16
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroU16>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroU16> for NonZeroI16` 1.49.0[src]

Attempts to convert `NonZeroU16` to `NonZeroI16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroU16
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU16>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroU16> for NonZeroU8` 1.49.0[src]

Attempts to convert `NonZeroU16` to `NonZeroU8`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroU16
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroU16>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroU32> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroU32` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroU32
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroU32>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroU64> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroU64` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroU64>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<NonZeroUsize> for NonZeroU16` 1.49.0[src]

Attempts to convert `NonZeroUsize` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: NonZeroUsize
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroUsize>>::Error>`[src]

Performs the conversion.

### `impl TryFrom<u16> for NonZeroU16` 1.46.0[src]

Attempts to convert `u16` to `NonZeroU16`.

#### `type Error = TryFromIntError`

The type returned in the event of a conversion error.

#### `pub fn try_from(
value: u16
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<u16>>::Error>`[src]

Performs the conversion.

### `impl UpperHex for NonZeroU16`[src]

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter.

## Auto Trait Implementations

### `impl RefUnwindSafe for NonZeroU16`

### `impl Send for NonZeroU16`

### `impl Sync for NonZeroU16`

### `impl Unpin for NonZeroU16`

### `impl UnwindSafe for NonZeroU16`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `pub fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T`[src]

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

#### `pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

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

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `pub default fn to_string(&self) -> String`[src]

Converts the given value to a `String`. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.