Struct sp_std::num::NonZeroI64

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

An integer that is known not to equal zero.

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

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

Implementations

impl NonZeroI64

pub const unsafe fn new_unchecked(n: i64) -> NonZeroI64

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: i64) -> Option<NonZeroI64>

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

pub const fn get(self) -> i64

Returns the value as a primitive type.

impl NonZeroI64

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

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

impl NonZeroI64

pub const fn abs(self) -> NonZeroI64

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

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

Example

#![feature(nonzero_ops)]

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

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

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

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

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

Example

#![feature(nonzero_ops)]

let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::MIN)?;

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

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

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

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

Example

#![feature(nonzero_ops)]

let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::MIN)?;

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

pub const fn saturating_abs(self) -> NonZeroI64

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

Saturating absolute value, see i64::saturating_abs.

Example

#![feature(nonzero_ops)]

let pos = NonZeroI64::new(1)?;
let neg = NonZeroI64::new(-1)?;
let min = NonZeroI64::new(i64::MIN)?;
let min_plus = NonZeroI64::new(i64::MIN + 1)?;
let max = NonZeroI64::new(i64::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());

pub const fn wrapping_abs(self) -> NonZeroI64

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

Wrapping absolute value, see i64::wrapping_abs.

Example

#![feature(nonzero_ops)]

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

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

pub const fn unsigned_abs(self) -> NonZeroU64

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

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

Example

#![feature(nonzero_ops)]

let u_pos = NonZeroU64::new(1)?;
let i_pos = NonZeroI64::new(1)?;
let i_neg = NonZeroI64::new(-1)?;
let i_min = NonZeroI64::new(i64::MIN)?;
let u_max = NonZeroU64::new(u64::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());

impl NonZeroI64

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

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

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 = NonZeroI64::new(2)?;
let four = NonZeroI64::new(4)?;
let max = NonZeroI64::new(i64::MAX)?;

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

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

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

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

Examples

#![feature(nonzero_ops)]

let two = NonZeroI64::new(2)?;
let four = NonZeroI64::new(4)?;
let max = NonZeroI64::new(i64::MAX)?;

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

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

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

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

Examples

#![feature(nonzero_ops)]

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

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

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

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

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 = NonZeroI64::new(3)?;
let twenty_seven = NonZeroI64::new(27)?;
let half_max = NonZeroI64::new(i64::MAX / 2)?;

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

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

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

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

Examples

#![feature(nonzero_ops)]

let three = NonZeroI64::new(3)?;
let twenty_seven = NonZeroI64::new(27)?;
let max = NonZeroI64::new(i64::MAX)?;

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

Trait Implementations

impl Binary for NonZeroI64

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

Formats the value using the given formatter.

impl BitOr<NonZeroI64> for NonZeroI64

type Output = NonZeroI64

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZeroI64> for i64

type Output = NonZeroI64

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<i64> for NonZeroI64

type Output = NonZeroI64

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<NonZeroI64> for NonZeroI64

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

Performs the |= operation.

impl BitOrAssign<i64> for NonZeroI64

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

Performs the |= operation.

impl Clone for NonZeroI64

pub fn clone(&self) -> NonZeroI64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonZeroI64

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

Formats the value using the given formatter.

impl Display for NonZeroI64

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

Formats the value using the given formatter.

impl From<NonZeroI16> for NonZeroI64

pub fn from(small: NonZeroI16) -> NonZeroI64

Converts NonZeroI16 to NonZeroI64 losslessly.

impl From<NonZeroI32> for NonZeroI64

pub fn from(small: NonZeroI32) -> NonZeroI64

Converts NonZeroI32 to NonZeroI64 losslessly.

impl From<NonZeroI64> for i64

pub fn from(nonzero: NonZeroI64) -> i64

Converts a NonZeroI64 into an i64

impl From<NonZeroI64> for NonZeroI128

pub fn from(small: NonZeroI64) -> NonZeroI128

Converts NonZeroI64 to NonZeroI128 losslessly.

impl From<NonZeroI8> for NonZeroI64

pub fn from(small: NonZeroI8) -> NonZeroI64

Converts NonZeroI8 to NonZeroI64 losslessly.

impl From<NonZeroU16> for NonZeroI64

pub fn from(small: NonZeroU16) -> NonZeroI64

Converts NonZeroU16 to NonZeroI64 losslessly.

impl From<NonZeroU32> for NonZeroI64

pub fn from(small: NonZeroU32) -> NonZeroI64

Converts NonZeroU32 to NonZeroI64 losslessly.

impl From<NonZeroU8> for NonZeroI64

pub fn from(small: NonZeroU8) -> NonZeroI64

Converts NonZeroU8 to NonZeroI64 losslessly.

impl FromStr for NonZeroI64

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for NonZeroI64

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

Feeds this value into the given Hasher.

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 NonZeroI64

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

Formats the value using the given formatter.

impl Octal for NonZeroI64

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

Formats the value using the given formatter.

impl Ord for NonZeroI64

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<NonZeroI64> for NonZeroI64

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

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

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

This method tests for !=.

impl PartialOrd<NonZeroI64> for NonZeroI64

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

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

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

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

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

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

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

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

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 NonZeroI64

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

Attempts to convert NonZeroI128 to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroUsize

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

Attempts to convert NonZeroI64 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroU16

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

Attempts to convert NonZeroI64 to NonZeroU16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroI32

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

Attempts to convert NonZeroI64 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroIsize

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

Attempts to convert NonZeroI64 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroI8

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

Attempts to convert NonZeroI64 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroU32

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

Attempts to convert NonZeroI64 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroU8

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

Attempts to convert NonZeroI64 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroU128

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

Attempts to convert NonZeroI64 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroU64

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

Attempts to convert NonZeroI64 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI64> for NonZeroI16

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

Attempts to convert NonZeroI64 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroIsize> for NonZeroI64

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

Attempts to convert NonZeroIsize to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU128> for NonZeroI64

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

Attempts to convert NonZeroU128 to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroU64> for NonZeroI64

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

Attempts to convert NonZeroU64 to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroUsize> for NonZeroI64

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

Attempts to convert NonZeroUsize to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<i64> for NonZeroI64

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

Attempts to convert i64 to NonZeroI64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl UpperHex for NonZeroI64

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

Formats the value using the given formatter.

impl Copy for NonZeroI64

impl Eq for NonZeroI64

impl StructuralEq for NonZeroI64

impl StructuralPartialEq for NonZeroI64