Struct std::num::NonZeroI128

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

An integer that is known not to equal zero.

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

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

Implementations

impl NonZeroI128

pub const unsafe fn new_unchecked(n: i128) -> NonZeroI128

Creates a non-zero without checking the value.

Safety

The value must not be zero.

pub const fn new(n: i128) -> Option<NonZeroI128>

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

pub const fn get(self) -> i128

Returns the value as a primitive type.

impl NonZeroI128

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

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

Trait Implementations

impl Binary for NonZeroI128

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

Formats the value using the given formatter.

impl BitOr<NonZeroI128> for i128

type Output = NonZeroI128

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZeroI128> for NonZeroI128

type Output = NonZeroI128

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<i128> for NonZeroI128

type Output = NonZeroI128

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<NonZeroI128> for NonZeroI128

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

Performs the |= operation.

impl BitOrAssign<i128> for NonZeroI128

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

Performs the |= operation.

impl Clone for NonZeroI128

pub fn clone(&self) -> NonZeroI128

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for NonZeroI128

impl Debug for NonZeroI128

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

Formats the value using the given formatter.

impl Display for NonZeroI128

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

Formats the value using the given formatter.

impl Eq for NonZeroI128

impl From<NonZeroI128> for i128

pub fn from(nonzero: NonZeroI128) -> i128

Converts a NonZeroI128 into an i128

impl From<NonZeroI16> for NonZeroI128

pub fn from(small: NonZeroI16) -> NonZeroI128

Converts NonZeroI16 to NonZeroI128 losslessly.

impl From<NonZeroI32> for NonZeroI128

pub fn from(small: NonZeroI32) -> NonZeroI128

Converts NonZeroI32 to NonZeroI128 losslessly.

impl From<NonZeroI64> for NonZeroI128

pub fn from(small: NonZeroI64) -> NonZeroI128

Converts NonZeroI64 to NonZeroI128 losslessly.

impl From<NonZeroI8> for NonZeroI128

pub fn from(small: NonZeroI8) -> NonZeroI128

Converts NonZeroI8 to NonZeroI128 losslessly.

impl From<NonZeroU16> for NonZeroI128

pub fn from(small: NonZeroU16) -> NonZeroI128

Converts NonZeroU16 to NonZeroI128 losslessly.

impl From<NonZeroU32> for NonZeroI128

pub fn from(small: NonZeroU32) -> NonZeroI128

Converts NonZeroU32 to NonZeroI128 losslessly.

impl From<NonZeroU64> for NonZeroI128

pub fn from(small: NonZeroU64) -> NonZeroI128

Converts NonZeroU64 to NonZeroI128 losslessly.

impl From<NonZeroU8> for NonZeroI128

pub fn from(small: NonZeroU8) -> NonZeroI128

Converts NonZeroU8 to NonZeroI128 losslessly.

impl FromStr for NonZeroI128

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for NonZeroI128

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 NonZeroI128

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

Formats the value using the given formatter.

impl Octal for NonZeroI128

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

Formats the value using the given formatter.

impl Ord for NonZeroI128

pub fn cmp(&self, other: &NonZeroI128) -> 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<NonZeroI128> for NonZeroI128

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

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

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

This method tests for !=.

impl PartialOrd<NonZeroI128> for NonZeroI128

pub fn partial_cmp(&self, other: &NonZeroI128) -> 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 StructuralEq for NonZeroI128

impl StructuralPartialEq for NonZeroI128

impl TryFrom<NonZeroI128> for NonZeroUsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroUsize.

impl TryFrom<NonZeroI128> for NonZeroIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroIsize.

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<NonZeroI128> for NonZeroI32

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroI32.

impl TryFrom<NonZeroI128> for NonZeroU8

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroU8.

impl TryFrom<NonZeroI128> for NonZeroI64

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroI64.

impl TryFrom<NonZeroI128> for NonZeroI8

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroI8.

impl TryFrom<NonZeroI128> for NonZeroU32

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroU32.

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

Attempts to convert NonZeroI128 to NonZeroU16.

impl TryFrom<NonZeroI128> for NonZeroU64

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroU64.

impl TryFrom<NonZeroI128> for NonZeroU128

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroI128 to NonZeroU128.

impl TryFrom<NonZeroIsize> for NonZeroI128

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroIsize to NonZeroI128.

impl TryFrom<NonZeroU128> for NonZeroI128

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroU128 to NonZeroI128.

impl TryFrom<NonZeroUsize> for NonZeroI128

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert NonZeroUsize to NonZeroI128.

impl TryFrom<i128> for NonZeroI128

type Error = TryFromIntError

The type returned in the event of a conversion error.

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

Attempts to convert i128 to NonZeroI128.

impl UpperHex for NonZeroI128

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

Formats the value using the given formatter.