Struct scale_info::prelude::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) -> NonZeroI32

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: i32) -> Option<NonZeroI32>

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

impl NonZeroI32

pub const fn abs(self) -> NonZeroI32

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

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

Example

#![feature(nonzero_ops)]

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

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

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

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

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

Example

#![feature(nonzero_ops)]

let pos = NonZeroI32::new(1)?;
let neg = NonZeroI32::new(-1)?;
let min = NonZeroI32::new(i32::MIN)?;

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

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

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

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

Example

#![feature(nonzero_ops)]

let pos = NonZeroI32::new(1)?;
let neg = NonZeroI32::new(-1)?;
let min = NonZeroI32::new(i32::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) -> NonZeroI32

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

Saturating absolute value, see i32::saturating_abs.

Example

#![feature(nonzero_ops)]

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

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

Wrapping absolute value, see i32::wrapping_abs.

Example

#![feature(nonzero_ops)]

let pos = NonZeroI32::new(1)?;
let neg = NonZeroI32::new(-1)?;
let min = NonZeroI32::new(i32::MIN)?;
let max = NonZeroI32::new(i32::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) -> NonZeroU32

🔬 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 = NonZeroU32::new(1)?;
let i_pos = NonZeroI32::new(1)?;
let i_neg = NonZeroI32::new(-1)?;
let i_min = NonZeroI32::new(i32::MIN)?;
let u_max = NonZeroU32::new(u32::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 NonZeroI32

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

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

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

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

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

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

Examples

#![feature(nonzero_ops)]

let two = NonZeroI32::new(2)?;
let four = NonZeroI32::new(4)?;
let max = NonZeroI32::new(i32::MAX)?;

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

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

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

Examples

#![feature(nonzero_ops)]

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

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

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

🔬 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 = NonZeroI32::new(3)?;
let twenty_seven = NonZeroI32::new(27)?;
let half_max = NonZeroI32::new(i32::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) -> NonZeroI32

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

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

Examples

#![feature(nonzero_ops)]

let three = NonZeroI32::new(3)?;
let twenty_seven = NonZeroI32::new(27)?;
let max = NonZeroI32::new(i32::MAX)?;

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

Trait Implementations

impl Binary for NonZeroI32

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

Formats the value using the given formatter.

impl BitOr<NonZeroI32> for i32

type Output = NonZeroI32

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<NonZeroI32> for NonZeroI32

type Output = NonZeroI32

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<i32> for NonZeroI32

type Output = NonZeroI32

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<NonZeroI32> for NonZeroI32

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

Performs the |= operation.

impl BitOrAssign<i32> for NonZeroI32

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

Performs the |= operation.

impl Clone for NonZeroI32

pub 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

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

Formats the value using the given formatter.

impl Decode for NonZeroI32

pub fn decode<I>(input: &mut I) -> Result<NonZeroI32, Error> where
    I: Input, 

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error> where
    I: Input, 

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<'de> Deserialize<'de> for NonZeroI32

pub fn deserialize<D>(
    deserializer: D
) -> Result<NonZeroI32, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for NonZeroI32

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

Formats the value using the given formatter.

impl Encode for NonZeroI32

pub fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

pub fn encode_to<W>(&self, dest: &mut W) where
    W: Output + ?Sized, 

Convert self to a slice and append it to the destination.

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

pub fn using_encoded<R, F>(&self, f: F) -> R where
    F: FnOnce(&[u8]) -> R, 

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<NonZeroI16> for NonZeroI32

pub fn from(small: NonZeroI16) -> NonZeroI32

Converts NonZeroI16 to NonZeroI32 losslessly.

impl From<NonZeroI32> for NonZeroI128

pub fn from(small: NonZeroI32) -> NonZeroI128

Converts NonZeroI32 to NonZeroI128 losslessly.

impl From<NonZeroI32> for NonZeroI64

pub fn from(small: NonZeroI32) -> NonZeroI64

Converts NonZeroI32 to NonZeroI64 losslessly.

impl From<NonZeroI8> for NonZeroI32

pub fn from(small: NonZeroI8) -> NonZeroI32

Converts NonZeroI8 to NonZeroI32 losslessly.

impl From<NonZeroU16> for NonZeroI32

pub fn from(small: NonZeroU16) -> NonZeroI32

Converts NonZeroU16 to NonZeroI32 losslessly.

impl From<NonZeroU8> for NonZeroI32

pub fn from(small: NonZeroU8) -> NonZeroI32

Converts NonZeroU8 to NonZeroI32 losslessly.

impl FromStr for NonZeroI32

type Err = ParseIntError

The associated error which can be returned from parsing.

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

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

impl Hash for NonZeroI32

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 NonZeroI32

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

Formats the value using the given formatter.

impl Octal for NonZeroI32

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

Formats the value using the given formatter.

impl Ord for NonZeroI32

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

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

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

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

This method tests for !=.

impl PartialOrd<NonZeroI32> for NonZeroI32

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

pub fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<NonZeroI128> for NonZeroI32

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

Attempts to convert NonZeroI128 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroIsize

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

Attempts to convert NonZeroI32 to NonZeroIsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU64

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

Attempts to convert NonZeroI32 to NonZeroU64.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroUsize

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

Attempts to convert NonZeroI32 to NonZeroUsize.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU8

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

Attempts to convert NonZeroI32 to NonZeroU8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroI8

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

Attempts to convert NonZeroI32 to NonZeroI8.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU128

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

Attempts to convert NonZeroI32 to NonZeroU128.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroI16

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

Attempts to convert NonZeroI32 to NonZeroI16.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU32

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

Attempts to convert NonZeroI32 to NonZeroU32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<NonZeroI32> for NonZeroU16

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

Attempts to convert NonZeroI32 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<NonZeroIsize> for NonZeroI32

pub fn try_from(
    value: NonZeroIsize
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroIsize>>::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

pub fn try_from(
    value: NonZeroU128
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroU128>>::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

pub fn try_from(
    value: NonZeroU32
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroU32>>::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

pub fn try_from(
    value: NonZeroU64
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroU64>>::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

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroUsize>>::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

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

Attempts to convert i32 to NonZeroI32.

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TypeInfo for NonZeroI32

type Identity = Self

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl UpperHex for NonZeroI32

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

Formats the value using the given formatter.

impl Copy for NonZeroI32

impl Eq for NonZeroI32

impl StructuralEq for NonZeroI32

impl StructuralPartialEq for NonZeroI32