# Struct std::num::NonZeroI16
1.34.0[−][src]

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

Expand description

An integer that is known not to equal zero.

This enables some memory layout optimization. For example, `Option<NonZeroI16>` is the same size as `i16`:

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

Run

## Implementations

`impl NonZeroI16`[src]
`pub const unsafe fn new_unchecked(n: i16) -> NonZeroI16` 1.34.0 (const: 1.34.0)[src]

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(n: i16) -> Option<NonZeroI16>`1.34.0 (const: 1.47.0)[src]

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

`pub const fn get(self) -> i16` 1.34.0 (const: 1.34.0)[src]

Returns the value as a primitive type.

`impl NonZeroI16`[src]
`pub const fn leading_zeros(self) -> u32` 1.53.0 (const: 1.53.0)[src]

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::NonZeroI16::new(-1i16).unwrap();

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

Run
`pub const fn trailing_zeros(self) -> u32` 1.53.0 (const: 1.53.0)[src]

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

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

Run
`impl NonZeroI16`[src]
`pub const fn abs(self) -> NonZeroI16`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Computes the absolute value of self. See `i16::abs` for documentation on overflow behaviour.

# Example

    #![feature(nonzero_ops)]

    let pos = NonZeroI16::new(1)?;
    let neg = NonZeroI16::new(-1)?;

    assert_eq!(pos, pos.abs());
    assert_eq!(pos, neg.abs());

Run
`pub const fn checked_abs(self) -> Option<NonZeroI16>`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Checked absolute value. Check for overflow and returns `None` if `self == i16::MIN`. The result cannot be zero.

# Example

    #![feature(nonzero_ops)]

    let pos = NonZeroI16::new(1)?;
    let neg = NonZeroI16::new(-1)?;
    let min = NonZeroI16::new(i16::MIN)?;

    assert_eq!(Some(pos), neg.checked_abs());
    assert_eq!(None, min.checked_abs());

Run
`pub const fn overflowing_abs(self) -> (NonZeroI16, bool)`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Computes the absolute value of self, with overflow information, see `i16::overflowing_abs`.

# Example

    #![feature(nonzero_ops)]

    let pos = NonZeroI16::new(1)?;
    let neg = NonZeroI16::new(-1)?;
    let min = NonZeroI16::new(i16::MIN)?;

    assert_eq!((pos, false), pos.overflowing_abs());
    assert_eq!((pos, false), neg.overflowing_abs());
    assert_eq!((min, true), min.overflowing_abs());

Run
`pub const fn saturating_abs(self) -> NonZeroI16`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Saturating absolute value, see `i16::saturating_abs`.

# Example

    #![feature(nonzero_ops)]

    let pos = NonZeroI16::new(1)?;
    let neg = NonZeroI16::new(-1)?;
    let min = NonZeroI16::new(i16::MIN)?;
    let min_plus = NonZeroI16::new(i16::MIN + 1)?;
    let max = NonZeroI16::new(i16::MAX)?;

    assert_eq!(pos, pos.saturating_abs());
    assert_eq!(pos, neg.saturating_abs());
    assert_eq!(max, min.saturating_abs());
    assert_eq!(max, min_plus.saturating_abs());

Run
`pub const fn wrapping_abs(self) -> NonZeroI16`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Wrapping absolute value, see `i16::wrapping_abs`.

# Example

    #![feature(nonzero_ops)]

    let pos = NonZeroI16::new(1)?;
    let neg = NonZeroI16::new(-1)?;
    let min = NonZeroI16::new(i16::MIN)?;
    let max = NonZeroI16::new(i16::MAX)?;

    assert_eq!(pos, pos.wrapping_abs());
    assert_eq!(pos, neg.wrapping_abs());
    assert_eq!(min, min.wrapping_abs());

Run
`pub const fn unsigned_abs(self) -> NonZeroU16`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Computes the absolute value of self without any wrapping or panicking.

# Example

    #![feature(nonzero_ops)]

    let u_pos = NonZeroU16::new(1)?;
    let i_pos = NonZeroI16::new(1)?;
    let i_neg = NonZeroI16::new(-1)?;
    let i_min = NonZeroI16::new(i16::MIN)?;
    let u_max = NonZeroU16::new(u16::MAX / 2 + 1)?;

    assert_eq!(u_pos, i_pos.unsigned_abs());
    assert_eq!(u_pos, i_neg.unsigned_abs());
    assert_eq!(u_max, i_min.unsigned_abs());

Run
`impl NonZeroI16`[src]
`pub const fn checked_mul(self, other: NonZeroI16) -> Option<NonZeroI16>`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Multiply two non-zero integers together. Check for overflow and return `None` on overflow. As a consequence, the result cannot wrap to zero.

# Examples

    #![feature(nonzero_ops)]

    let two = NonZeroI16::new(2)?;
    let four = NonZeroI16::new(4)?;
    let max = NonZeroI16::new(i16::MAX)?;

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

Run
`pub const fn saturating_mul(self, other: NonZeroI16) -> NonZeroI16`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Multiply two non-zero integers together. Return `i16::MAX` on overflow.

# Examples

    #![feature(nonzero_ops)]

    let two = NonZeroI16::new(2)?;
    let four = NonZeroI16::new(4)?;
    let max = NonZeroI16::new(i16::MAX)?;

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

Run
`pub unsafe fn unchecked_mul(self, other: NonZeroI16) -> NonZeroI16`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Multiply 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 > i16::MAX`, or `self * rhs < i16::MIN`.

# Examples

    #![feature(nonzero_ops)]

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

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

Run
`pub const fn checked_pow(self, other: u32) -> Option<NonZeroI16>`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Raise non-zero value to an integer power. Check for overflow and return `None` on overflow. As a consequence, the result cannot wrap to zero.

# Examples

    #![feature(nonzero_ops)]

    let three = NonZeroI16::new(3)?;
    let twenty_seven = NonZeroI16::new(27)?;
    let half_max = NonZeroI16::new(i16::MAX / 2)?;

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

Run
`pub const fn saturating_pow(self, other: u32) -> NonZeroI16`[src]
🔬 This is a nightly-only experimental API. (`nonzero_ops` #84186)

Raise non-zero value to an integer power. Return `i16::MIN` or `i16::MAX` on overflow.

# Examples

    #![feature(nonzero_ops)]

    let three = NonZeroI16::new(3)?;
    let twenty_seven = NonZeroI16::new(27)?;
    let max = NonZeroI16::new(i16::MAX)?;

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

Run

## Trait Implementations

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

Formats the value using the given formatter.

`impl BitOr<NonZeroI16> for i16` 1.45.0[src]
`type Output = NonZeroI16`

The resulting type after applying the `|` operator.

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

Performs the `|` operation. Read more

`impl BitOr<NonZeroI16> for NonZeroI16` 1.45.0[src]
`type Output = NonZeroI16`

The resulting type after applying the `|` operator.

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

Performs the `|` operation. Read more

`impl BitOr<i16> for NonZeroI16` 1.45.0[src]
`type Output = NonZeroI16`

The resulting type after applying the `|` operator.

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

Performs the `|` operation. Read more

`impl BitOrAssign<NonZeroI16> for NonZeroI16` 1.45.0[src]
`pub fn bitor_assign(&mut self, rhs: NonZeroI16)`[src]

Performs the `|=` operation. Read more

`impl BitOrAssign<i16> for NonZeroI16` 1.45.0[src]
`pub fn bitor_assign(&mut self, rhs: i16)`[src]

Performs the `|=` operation. Read more

`impl Clone for NonZeroI16`[src]
`pub fn clone(&self) -> NonZeroI16`[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 Debug for NonZeroI16`[src]
`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

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

Formats the value using the given formatter. Read more

`impl From<NonZeroI16> for NonZeroIsize` 1.41.0[src]
`pub fn from(small: NonZeroI16) -> NonZeroIsize`[src]

Converts `NonZeroI16` to `NonZeroIsize` losslessly.

`impl From<NonZeroI16> for NonZeroI32` 1.41.0[src]
`pub fn from(small: NonZeroI16) -> NonZeroI32`[src]

Converts `NonZeroI16` to `NonZeroI32` losslessly.

`impl From<NonZeroI16> for i16` 1.31.0[src]
`pub fn from(nonzero: NonZeroI16) -> i16`[src]

Converts a `NonZeroI16` into an `i16`

`impl From<NonZeroI16> for NonZeroI64` 1.41.0[src]
`pub fn from(small: NonZeroI16) -> NonZeroI64`[src]

Converts `NonZeroI16` to `NonZeroI64` losslessly.

`impl From<NonZeroI16> for NonZeroI128` 1.41.0[src]
`pub fn from(small: NonZeroI16) -> NonZeroI128`[src]

Converts `NonZeroI16` to `NonZeroI128` losslessly.

`impl From<NonZeroI8> for NonZeroI16` 1.41.0[src]
`pub fn from(small: NonZeroI8) -> NonZeroI16`[src]

Converts `NonZeroI8` to `NonZeroI16` losslessly.

`impl From<NonZeroU8> for NonZeroI16` 1.41.0[src]
`pub fn from(small: NonZeroU8) -> NonZeroI16`[src]

Converts `NonZeroU8` to `NonZeroI16` losslessly.

`impl FromStr for NonZeroI16` 1.35.0[src]
`type Err = ParseIntError`

The associated error which can be returned from parsing.

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

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

`impl Hash for NonZeroI16`[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 NonZeroI16`[src]
`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter.

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

Formats the value using the given formatter.

`impl Ord for NonZeroI16`[src]
`pub fn cmp(&self, other: &NonZeroI16) -> Ordering`[src]

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

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

Compares and returns the maximum of two values. Read more

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

Compares and returns the minimum of two values. Read more

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

Restrict a value to a certain interval. Read more

`impl PartialEq<NonZeroI16> for NonZeroI16`[src]
`pub fn eq(&self, other: &NonZeroI16) -> bool`[src]

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

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

This method tests for `!=`.

`impl PartialOrd<NonZeroI16> for NonZeroI16`[src]
`pub fn partial_cmp(&self, other: &NonZeroI16) -> Option<Ordering>`[src]

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

`fn lt(&self, other: &Rhs) -> bool` 1.0.0[src]

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

`fn le(&self, other: &Rhs) -> bool` 1.0.0[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: &Rhs) -> bool` 1.0.0[src]

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

`fn ge(&self, other: &Rhs) -> bool` 1.0.0[src]

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

`impl TryFrom<NonZeroI128> for NonZeroI16` 1.49.0[src]
`pub fn try_from(
value: NonZeroI128
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroI128>>::Error>`[src]

Attempts to convert `NonZeroI128` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroI16> for NonZeroU64` 1.49.0[src]
`pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroI16>>::Error>`[src]

Attempts to convert `NonZeroI16` to `NonZeroU64`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

Attempts to convert `NonZeroI16` to `NonZeroU16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroI16> for NonZeroU128` 1.49.0[src]
`pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroI16>>::Error>`[src]

Attempts to convert `NonZeroI16` to `NonZeroU128`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroI16> for NonZeroU32` 1.49.0[src]
`pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroI16>>::Error>`[src]

Attempts to convert `NonZeroI16` to `NonZeroU32`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroI16> for NonZeroI8` 1.49.0[src]
`pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroI16>>::Error>`[src]

Attempts to convert `NonZeroI16` to `NonZeroI8`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroI16> for NonZeroU8` 1.49.0[src]
`pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroI16>>::Error>`[src]

Attempts to convert `NonZeroI16` to `NonZeroU8`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroI16> for NonZeroUsize` 1.49.0[src]
`pub fn try_from(
value: NonZeroI16
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI16>>::Error>`[src]

Attempts to convert `NonZeroI16` to `NonZeroUsize`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroI32> for NonZeroI16` 1.49.0[src]
`pub fn try_from(
value: NonZeroI32
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroI32>>::Error>`[src]

Attempts to convert `NonZeroI32` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroI64> for NonZeroI16` 1.49.0[src]
`pub fn try_from(
value: NonZeroI64
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroI64>>::Error>`[src]

Attempts to convert `NonZeroI64` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroIsize> for NonZeroI16` 1.49.0[src]
`pub fn try_from(
value: NonZeroIsize
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroIsize>>::Error>`[src]

Attempts to convert `NonZeroIsize` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroU128> for NonZeroI16` 1.49.0[src]
`pub fn try_from(
value: NonZeroU128
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU128>>::Error>`[src]

Attempts to convert `NonZeroU128` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

Attempts to convert `NonZeroU16` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroU32> for NonZeroI16` 1.49.0[src]
`pub fn try_from(
value: NonZeroU32
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU32>>::Error>`[src]

Attempts to convert `NonZeroU32` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroU64> for NonZeroI16` 1.49.0[src]
`pub fn try_from(
value: NonZeroU64
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroU64>>::Error>`[src]

Attempts to convert `NonZeroU64` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<NonZeroUsize> for NonZeroI16` 1.49.0[src]
`pub fn try_from(
value: NonZeroUsize
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroUsize>>::Error>`[src]

Attempts to convert `NonZeroUsize` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

`impl TryFrom<i16> for NonZeroI16` 1.46.0[src]
`pub fn try_from(
value: i16
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<i16>>::Error>`[src]

Attempts to convert `i16` to `NonZeroI16`.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

Formats the value using the given formatter.

`impl Copy for NonZeroI16`[src]
`impl Eq for NonZeroI16`[src]
`impl StructuralEq for NonZeroI16`[src]
`impl StructuralPartialEq for NonZeroI16`[src]

## Auto Trait Implementations

`impl RefUnwindSafe for NonZeroI16`
`impl Send for NonZeroI16`
`impl Sync for NonZeroI16`
`impl Unpin for NonZeroI16`
`impl UnwindSafe for NonZeroI16`

## 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`[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`[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.