Struct sp_std::num::NonZeroI16

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

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

Implementations

impl NonZeroI16

pub const unsafe fn new_unchecked(n: i16) -> NonZeroI16

Creates a non-zero without checking the value.

Safety

The value must not be zero.

pub const fn new(n: i16) -> Option<NonZeroI16>

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

pub const fn get(self) -> i16

Returns the value as a primitive type.

impl NonZeroI16

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

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

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

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

Trait Implementations

impl Binary for NonZeroI16

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

Formats the value using the given formatter.

impl BitOr<NonZeroI16> for NonZeroI16

type Output = NonZeroI16

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZeroI16> for i16

type Output = NonZeroI16

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<i16> for NonZeroI16

type Output = NonZeroI16

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<NonZeroI16> for NonZeroI16

pub fn bitor_assign(&mut self, rhs: NonZeroI16)

Performs the |= operation.

impl BitOrAssign<i16> for NonZeroI16

pub fn bitor_assign(&mut self, rhs: i16)

Performs the |= operation.

impl Clone for NonZeroI16

pub fn clone(&self) -> NonZeroI16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonZeroI16

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

Formats the value using the given formatter.

impl Display for NonZeroI16

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

Formats the value using the given formatter.

impl From<NonZeroI16> for i16

pub fn from(nonzero: NonZeroI16) -> i16

Converts a NonZeroI16 into an i16

impl From<NonZeroI16> for NonZeroI64

pub fn from(small: NonZeroI16) -> NonZeroI64

Converts NonZeroI16 to NonZeroI64 losslessly.

impl From<NonZeroI16> for NonZeroIsize

pub fn from(small: NonZeroI16) -> NonZeroIsize

Converts NonZeroI16 to NonZeroIsize losslessly.

impl From<NonZeroI16> for NonZeroI32

pub fn from(small: NonZeroI16) -> NonZeroI32

Converts NonZeroI16 to NonZeroI32 losslessly.

impl From<NonZeroI16> for NonZeroI128

pub fn from(small: NonZeroI16) -> NonZeroI128

Converts NonZeroI16 to NonZeroI128 losslessly.

impl From<NonZeroI8> for NonZeroI16

pub fn from(small: NonZeroI8) -> NonZeroI16

Converts NonZeroI8 to NonZeroI16 losslessly.

impl From<NonZeroU8> for NonZeroI16

pub fn from(small: NonZeroU8) -> NonZeroI16

Converts NonZeroU8 to NonZeroI16 losslessly.

impl FromStr for NonZeroI16

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for NonZeroI16

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for NonZeroI16

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

Formats the value using the given formatter.

impl Octal for NonZeroI16

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

Formats the value using the given formatter.

impl Ord for NonZeroI16

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

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<NonZeroI16> for NonZeroI16

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

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

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

This method tests for !=.

impl PartialOrd<NonZeroI16> for NonZeroI16

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 TryFrom<NonZeroI128> for NonZeroI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroI16.

impl TryFrom<NonZeroI16> for 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>

Attempts to convert NonZeroI16 to NonZeroU16.

impl TryFrom<NonZeroI16> for NonZeroUsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI16 to NonZeroUsize.

impl TryFrom<NonZeroI16> for NonZeroU128

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI16 to NonZeroU128.

impl TryFrom<NonZeroI16> for NonZeroU64

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI16 to NonZeroU64.

impl TryFrom<NonZeroI16> for NonZeroU32

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI16 to NonZeroU32.

impl TryFrom<NonZeroI16> for NonZeroI8

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI16 to NonZeroI8.

impl TryFrom<NonZeroI16> for NonZeroU8

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI16 to NonZeroU8.

impl TryFrom<NonZeroI32> for NonZeroI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI32 to NonZeroI16.

impl TryFrom<NonZeroI64> for NonZeroI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI64 to NonZeroI16.

impl TryFrom<NonZeroIsize> for NonZeroI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroIsize to NonZeroI16.

impl TryFrom<NonZeroU128> for NonZeroI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroU128 to NonZeroI16.

impl TryFrom<NonZeroU16> for 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>

Attempts to convert NonZeroU16 to NonZeroI16.

impl TryFrom<NonZeroU32> for NonZeroI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroU32 to NonZeroI16.

impl TryFrom<NonZeroU64> for NonZeroI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroU64 to NonZeroI16.

impl TryFrom<NonZeroUsize> for NonZeroI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroUsize to NonZeroI16.

impl TryFrom<i16> for NonZeroI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert i16 to NonZeroI16.

impl UpperHex for NonZeroI16

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

Formats the value using the given formatter.

impl Copy for NonZeroI16

impl Eq for NonZeroI16

impl StructuralEq for NonZeroI16

impl StructuralPartialEq for NonZeroI16