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

# 1.28.0[−][src]Struct core::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<std::num::NonZeroU16>>(), size_of::<u16>());Run

## Methods

###

`impl NonZeroU16`

[src]

####

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

[src]

Create a non-zero without checking the value.

# Safety

The value must not be zero.

####

`pub fn new(n: u16) -> Option<Self>`

[src]

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

####

`pub fn get(self) -> u16`

[src]

Returns the value as a primitive type.

## Trait Implementations

###

`impl Copy for NonZeroU16`

[src]

###

`impl PartialEq<NonZeroU16> for NonZeroU16`

[src]

####

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

[src]

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

####

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

[src]

This method tests for `!=`.

###

`impl Eq for NonZeroU16`

[src]

###

`impl Ord for NonZeroU16`

[src]

####

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

[src]

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

####

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

1.21.0
[src]

Compares and returns the maximum of two values. Read more

####

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

1.21.0
[src]

Compares and returns the minimum of two values. Read more

###

`impl PartialOrd<NonZeroU16> for NonZeroU16`

[src]

####

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

[src]

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

####

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

[src]

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

####

`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

####

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

[src]

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

####

`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 Clone for NonZeroU16`

[src]

####

`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 From<NonZeroU16> for u16`

1.31.0
[src]

####

`fn from(nonzero: NonZeroU16) -> Self`

[src]

Performs the conversion.

###

`impl Hash for NonZeroU16`

[src]

####

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

[src]

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

####

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

1.3.0
[src]

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

###

`impl Debug for NonZeroU16`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl Display for NonZeroU16`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl Octal for NonZeroU16`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter.

###

`impl Binary for NonZeroU16`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter.

###

`impl LowerHex for NonZeroU16`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter.

###

`impl UpperHex for NonZeroU16`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter.

## Auto Trait Implementations

###

`impl Send for NonZeroU16`

###

`impl Sync for NonZeroU16`

## Blanket Implementations

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(Self) -> U`

[src]

Performs the conversion.

###

`impl<T> From for T`

[src]

####

`fn from(T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

`fn borrow(&Self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####

`fn borrow_mut(&mut Self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

####

`fn get_type_id(&Self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)