Struct core::num::NonZeroI128

1.34.0 · source ·
#[repr(transparent)]
pub struct NonZeroI128(_);
Expand description

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

Implementations§

source§

impl NonZeroI128

const: 1.34.0 · source

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

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.

const: 1.47.0 · source

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

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

const: 1.34.0 · source

pub const fn get(self) -> i128

Returns the value as a primitive type.

source§

impl NonZeroI128

1.53.0 (const: 1.53.0) · source

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);
Run
1.53.0 (const: 1.53.0) · source

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);
Run
source§

impl NonZeroI128

1.64.0 (const: 1.64.0) · source

pub const fn abs(self) -> NonZeroI128

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

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

assert_eq!(pos, pos.abs());
assert_eq!(pos, neg.abs());
Run
1.64.0 (const: 1.64.0) · source

pub const fn checked_abs(self) -> Option<NonZeroI128>

Checked absolute value. Checks for overflow and returns None if self == i128::MIN. The result cannot be zero.

Example
let pos = NonZeroI128::new(1)?;
let neg = NonZeroI128::new(-1)?;
let min = NonZeroI128::new(i128::MIN)?;

assert_eq!(Some(pos), neg.checked_abs());
assert_eq!(None, min.checked_abs());
Run
1.64.0 (const: 1.64.0) · source

pub const fn overflowing_abs(self) -> (NonZeroI128, bool)

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

Example
let pos = NonZeroI128::new(1)?;
let neg = NonZeroI128::new(-1)?;
let min = NonZeroI128::new(i128::MIN)?;

assert_eq!((pos, false), pos.overflowing_abs());
assert_eq!((pos, false), neg.overflowing_abs());
assert_eq!((min, true), min.overflowing_abs());
Run
1.64.0 (const: 1.64.0) · source

pub const fn saturating_abs(self) -> NonZeroI128

Saturating absolute value, see i128::saturating_abs.

Example
let pos = NonZeroI128::new(1)?;
let neg = NonZeroI128::new(-1)?;
let min = NonZeroI128::new(i128::MIN)?;
let min_plus = NonZeroI128::new(i128::MIN + 1)?;
let max = NonZeroI128::new(i128::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
1.64.0 (const: 1.64.0) · source

pub const fn wrapping_abs(self) -> NonZeroI128

Wrapping absolute value, see i128::wrapping_abs.

Example
let pos = NonZeroI128::new(1)?;
let neg = NonZeroI128::new(-1)?;
let min = NonZeroI128::new(i128::MIN)?;

assert_eq!(pos, pos.wrapping_abs());
assert_eq!(pos, neg.wrapping_abs());
assert_eq!(min, min.wrapping_abs());
Run
1.64.0 (const: 1.64.0) · source

pub const fn unsigned_abs(self) -> NonZeroU128

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

Example

let u_pos = NonZeroU128::new(1)?;
let i_pos = NonZeroI128::new(1)?;
let i_neg = NonZeroI128::new(-1)?;
let i_min = NonZeroI128::new(i128::MIN)?;
let u_max = NonZeroU128::new(u128::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
source

pub const fn is_negative(self) -> bool

🔬This is a nightly-only experimental API. (nonzero_negation_ops #102443)

Returns true if self is negative and false if the number is positive.

Example
#![feature(nonzero_negation_ops)]

let pos_five = NonZeroI128::new(5)?;
let neg_five = NonZeroI128::new(-5)?;

assert!(neg_five.is_negative());
assert!(!pos_five.is_negative());
Run
source

pub const fn checked_neg(self) -> Option<NonZeroI128>

🔬This is a nightly-only experimental API. (nonzero_negation_ops #102443)

Checked negation. Computes -self, returning None if self == i32::MIN.

Example
#![feature(nonzero_negation_ops)]

let pos_five = NonZeroI128::new(5)?;
let neg_five = NonZeroI128::new(-5)?;
let min = NonZeroI128::new(i128::MIN)?;

assert_eq!(pos_five.checked_neg(), Some(neg_five));
assert_eq!(min.checked_neg(), None);
Run
source

pub const fn overflowing_neg(self) -> (NonZeroI128, bool)

🔬This is a nightly-only experimental API. (nonzero_negation_ops #102443)

Negates self, overflowing if this is equal to the minimum value.

See i128::overflowing_neg for documentation on overflow behaviour.

Example
#![feature(nonzero_negation_ops)]

let pos_five = NonZeroI128::new(5)?;
let neg_five = NonZeroI128::new(-5)?;
let min = NonZeroI128::new(i128::MIN)?;

assert_eq!(pos_five.overflowing_neg(), (neg_five, false));
assert_eq!(min.overflowing_neg(), (min, true));
Run
source

pub const fn saturating_neg(self) -> NonZeroI128

🔬This is a nightly-only experimental API. (nonzero_negation_ops #102443)

Saturating negation. Computes -self, returning MAX if self == i32::MIN instead of overflowing.

Example
#![feature(nonzero_negation_ops)]

let pos_five = NonZeroI128::new(5)?;
let neg_five = NonZeroI128::new(-5)?;
let min = NonZeroI128::new(i128::MIN)?;
let min_plus_one = NonZeroI128::new(i128::MIN + 1)?;
let max = NonZeroI128::new(i128::MAX)?;

assert_eq!(pos_five.saturating_neg(), neg_five);
assert_eq!(min.saturating_neg(), max);
assert_eq!(max.saturating_neg(), min_plus_one);
Run
source

pub const fn wrapping_neg(self) -> NonZeroI128

🔬This is a nightly-only experimental API. (nonzero_negation_ops #102443)

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

See i128::wrapping_neg for documentation on overflow behaviour.

Example
#![feature(nonzero_negation_ops)]

let pos_five = NonZeroI128::new(5)?;
let neg_five = NonZeroI128::new(-5)?;
let min = NonZeroI128::new(i128::MIN)?;

assert_eq!(pos_five.wrapping_neg(), neg_five);
assert_eq!(min.wrapping_neg(), min);
Run
source§

impl NonZeroI128

1.64.0 (const: 1.64.0) · source

pub const fn checked_mul(self, other: NonZeroI128) -> Option<NonZeroI128>

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples
let two = NonZeroI128::new(2)?;
let four = NonZeroI128::new(4)?;
let max = NonZeroI128::new(i128::MAX)?;

assert_eq!(Some(four), two.checked_mul(two));
assert_eq!(None, max.checked_mul(two));
Run
1.64.0 (const: 1.64.0) · source

pub const fn saturating_mul(self, other: NonZeroI128) -> NonZeroI128

Multiplies two non-zero integers together. Return i128::MAX on overflow.

Examples
let two = NonZeroI128::new(2)?;
let four = NonZeroI128::new(4)?;
let max = NonZeroI128::new(i128::MAX)?;

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

pub const unsafe fn unchecked_mul(self, other: NonZeroI128) -> NonZeroI128

🔬This is a nightly-only experimental API. (nonzero_ops #84186)

Multiplies 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 > i128::MAX, or self * rhs < i128::MIN.

Examples
#![feature(nonzero_ops)]

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

assert_eq!(four, unsafe { two.unchecked_mul(two) });
Run
1.64.0 (const: 1.64.0) · source

pub const fn checked_pow(self, other: u32) -> Option<NonZeroI128>

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

Examples
let three = NonZeroI128::new(3)?;
let twenty_seven = NonZeroI128::new(27)?;
let half_max = NonZeroI128::new(i128::MAX / 2)?;

assert_eq!(Some(twenty_seven), three.checked_pow(3));
assert_eq!(None, half_max.checked_pow(3));
Run
1.64.0 (const: 1.64.0) · source

pub const fn saturating_pow(self, other: u32) -> NonZeroI128

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

Examples
let three = NonZeroI128::new(3)?;
let twenty_seven = NonZeroI128::new(27)?;
let max = NonZeroI128::new(i128::MAX)?;

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

impl NonZeroI128

source

pub const MIN: Self = _

🔬This is a nightly-only experimental API. (nonzero_min_max #89065)

The smallest value that can be represented by this non-zero integer type, equal to i128::MIN.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples
#![feature(nonzero_min_max)]

assert_eq!(NonZeroI128::MIN.get(), i128::MIN);
Run
source

pub const MAX: Self = _

🔬This is a nightly-only experimental API. (nonzero_min_max #89065)

The largest value that can be represented by this non-zero integer type, equal to i128::MAX.

Note: While most integer types are defined for every whole number between MIN and MAX, signed non-zero integers are a special case. They have a “gap” at 0.

Examples
#![feature(nonzero_min_max)]

assert_eq!(NonZeroI128::MAX.get(), i128::MAX);
Run
source§

impl NonZeroI128

1.67.0 · source

pub const BITS: u32 = 128u32

The size of this non-zero integer type in bits.

This value is equal to i128::BITS.

Examples

assert_eq!(NonZeroI128::BITS, i128::BITS);
Run

Trait Implementations§

source§

impl Binary for NonZeroI128

source§

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

Formats the value using the given formatter.
1.45.0 (const: unstable) · source§

impl BitOr<NonZeroI128> for NonZeroI128

§

type Output = NonZeroI128

The resulting type after applying the | operator.
const: unstable · source§

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

Performs the | operation. Read more
1.45.0 (const: unstable) · source§

impl BitOr<NonZeroI128> for i128

§

type Output = NonZeroI128

The resulting type after applying the | operator.
const: unstable · source§

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

Performs the | operation. Read more
1.45.0 (const: unstable) · source§

impl BitOr<i128> for NonZeroI128

§

type Output = NonZeroI128

The resulting type after applying the | operator.
const: unstable · source§

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

Performs the | operation. Read more
1.45.0 (const: unstable) · source§

impl BitOrAssign<NonZeroI128> for NonZeroI128

const: unstable · source§

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation. Read more
1.45.0 (const: unstable) · source§

impl BitOrAssign<i128> for NonZeroI128

const: unstable · source§

fn bitor_assign(&mut self, rhs: i128)

Performs the |= operation. Read more
source§

impl Clone for NonZeroI128

source§

fn clone(&self) -> NonZeroI128

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for NonZeroI128

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for NonZeroI128

source§

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

Formats the value using the given formatter. Read more
1.31.0 (const: unstable) · source§

impl From<NonZeroI128> for i128

const: unstable · source§

fn from(nonzero: NonZeroI128) -> Self

Converts a NonZeroI128 into an i128

1.41.0 (const: unstable) · source§

impl From<NonZeroI16> for NonZeroI128

const: unstable · source§

fn from(small: NonZeroI16) -> Self

Converts NonZeroI16 to NonZeroI128 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroI32> for NonZeroI128

const: unstable · source§

fn from(small: NonZeroI32) -> Self

Converts NonZeroI32 to NonZeroI128 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroI64> for NonZeroI128

const: unstable · source§

fn from(small: NonZeroI64) -> Self

Converts NonZeroI64 to NonZeroI128 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroI8> for NonZeroI128

const: unstable · source§

fn from(small: NonZeroI8) -> Self

Converts NonZeroI8 to NonZeroI128 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU16> for NonZeroI128

const: unstable · source§

fn from(small: NonZeroU16) -> Self

Converts NonZeroU16 to NonZeroI128 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU32> for NonZeroI128

const: unstable · source§

fn from(small: NonZeroU32) -> Self

Converts NonZeroU32 to NonZeroI128 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU64> for NonZeroI128

const: unstable · source§

fn from(small: NonZeroU64) -> Self

Converts NonZeroU64 to NonZeroI128 losslessly.

1.41.0 (const: unstable) · source§

impl From<NonZeroU8> for NonZeroI128

const: unstable · source§

fn from(small: NonZeroU8) -> Self

Converts NonZeroU8 to NonZeroI128 losslessly.

1.35.0 · source§

impl FromStr for NonZeroI128

§

type Err = ParseIntError

The associated error which can be returned from parsing.
source§

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

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

impl Hash for NonZeroI128

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl LowerHex for NonZeroI128

source§

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

Formats the value using the given formatter.
source§

impl Octal for NonZeroI128

source§

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

Formats the value using the given formatter.
source§

impl Ord for NonZeroI128

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<NonZeroI128> for NonZeroI128

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd<NonZeroI128> for NonZeroI128

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

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

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

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

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

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

impl TryFrom<NonZeroI128> for NonZeroI16

source§

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

Attempts to convert NonZeroI128 to NonZeroI16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroI32

source§

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.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroI64

source§

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

Attempts to convert NonZeroI128 to NonZeroI64.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroI8

source§

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

Attempts to convert NonZeroI128 to NonZeroI8.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroIsize

source§

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

Attempts to convert NonZeroI128 to NonZeroIsize.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroU128

source§

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

Attempts to convert NonZeroI128 to NonZeroU128.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroU16

source§

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

Attempts to convert NonZeroI128 to NonZeroU16.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroU32

source§

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

Attempts to convert NonZeroI128 to NonZeroU32.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroU64

source§

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

Attempts to convert NonZeroI128 to NonZeroU64.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroU8

source§

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

Attempts to convert NonZeroI128 to NonZeroU8.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroI128> for NonZeroUsize

source§

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

Attempts to convert NonZeroI128 to NonZeroUsize.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroIsize> for NonZeroI128

source§

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

Attempts to convert NonZeroIsize to NonZeroI128.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroU128> for NonZeroI128

source§

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

Attempts to convert NonZeroU128 to NonZeroI128.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.49.0 · source§

impl TryFrom<NonZeroUsize> for NonZeroI128

source§

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

Attempts to convert NonZeroUsize to NonZeroI128.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
1.46.0 · source§

impl TryFrom<i128> for NonZeroI128

source§

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

Attempts to convert i128 to NonZeroI128.

§

type Error = TryFromIntError

The type returned in the event of a conversion error.
source§

impl UpperHex for NonZeroI128

source§

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

Formats the value using the given formatter.
source§

impl Copy for NonZeroI128

source§

impl Eq for NonZeroI128

source§

impl StructuralEq for NonZeroI128

source§

impl StructuralPartialEq for NonZeroI128

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.