Struct core::num::NonZeroI32

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

An integer that is known not to equal zero.

This enables some memory layout optimization. For example, Option<NonZeroI32> is the same size as i32:

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

Implementations

impl NonZeroI32

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

Creates a non-zero without checking the value.

Safety

The value must not be zero.

pub const fn new(n: i32) -> Option<Self>

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

pub const fn get(self) -> i32

Returns the value as a primitive type.

impl NonZeroI32

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

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

Trait Implementations

impl Binary for NonZeroI32

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

Formats the value using the given formatter.

impl BitOr<NonZeroI32> for NonZeroI32

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr<NonZeroI32> for i32

type Output = NonZeroI32

The resulting type after applying the | operator.

fn bitor(self, rhs: NonZeroI32) -> Self::Output

Performs the | operation.

impl BitOr<i32> for NonZeroI32

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, rhs: i32) -> Self::Output

Performs the | operation.

impl BitOrAssign<NonZeroI32> for NonZeroI32

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitOrAssign<i32> for NonZeroI32

fn bitor_assign(&mut self, rhs: i32)

Performs the |= operation.

impl Clone for NonZeroI32

fn clone(&self) -> NonZeroI32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonZeroI32

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

Formats the value using the given formatter.

impl Display for NonZeroI32

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

Formats the value using the given formatter.

impl From<NonZeroI16> for NonZeroI32

fn from(small: NonZeroI16) -> Self

Converts NonZeroI16 to NonZeroI32 losslessly.

impl From<NonZeroI32> for i32

fn from(nonzero: NonZeroI32) -> Self

Converts a NonZeroI32 into an i32

impl From<NonZeroI32> for NonZeroI64

fn from(small: NonZeroI32) -> Self

Converts NonZeroI32 to NonZeroI64 losslessly.

impl From<NonZeroI32> for NonZeroI128

fn from(small: NonZeroI32) -> Self

Converts NonZeroI32 to NonZeroI128 losslessly.

impl From<NonZeroI8> for NonZeroI32

fn from(small: NonZeroI8) -> Self

Converts NonZeroI8 to NonZeroI32 losslessly.

impl From<NonZeroU16> for NonZeroI32

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroI32 losslessly.

impl From<NonZeroU8> for NonZeroI32

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroI32 losslessly.

impl FromStr for NonZeroI32

type Err = ParseIntError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, Self::Err>

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

impl Hash for NonZeroI32

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for NonZeroI32

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

Formats the value using the given formatter.

impl Octal for NonZeroI32

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

Formats the value using the given formatter.

impl Ord for NonZeroI32

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<NonZeroI32> for NonZeroI32

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

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

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

This method tests for !=.

impl PartialOrd<NonZeroI32> for NonZeroI32

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

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

#[must_use]

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

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

#[must_use]

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]

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

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

#[must_use]

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 NonZeroI32

fn try_from(value: NonZeroI128) -> Result<Self, Self::Error>

Attempts to convert NonZeroI128 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU8

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU16

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU32

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU64

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU128

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroUsize

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroI8

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroI16

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroIsize

fn try_from(value: NonZeroI32) -> Result<Self, Self::Error>

Attempts to convert NonZeroI32 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroI32

fn try_from(value: NonZeroI64) -> Result<Self, Self::Error>

Attempts to convert NonZeroI64 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroIsize> for NonZeroI32

fn try_from(value: NonZeroIsize) -> Result<Self, Self::Error>

Attempts to convert NonZeroIsize to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroI32

fn try_from(value: NonZeroU128) -> Result<Self, Self::Error>

Attempts to convert NonZeroU128 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU32> for NonZeroI32

fn try_from(value: NonZeroU32) -> Result<Self, Self::Error>

Attempts to convert NonZeroU32 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU64> for NonZeroI32

fn try_from(value: NonZeroU64) -> Result<Self, Self::Error>

Attempts to convert NonZeroU64 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroUsize> for NonZeroI32

fn try_from(value: NonZeroUsize) -> Result<Self, Self::Error>

Attempts to convert NonZeroUsize to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<i32> for NonZeroI32

fn try_from(value: i32) -> Result<Self, Self::Error>

Attempts to convert i32 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl UpperHex for NonZeroI32

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

Formats the value using the given formatter.

impl Copy for NonZeroI32

impl Eq for NonZeroI32

impl StructuralEq for NonZeroI32

impl StructuralPartialEq for NonZeroI32