# Struct core::num::NonZeroI8

1.34.0· source · [−]

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

Expand description

An integer that is known not to equal zero.

This enables some memory layout optimization. For example, `Option<NonZeroI8>` is the same size as `i8`:

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

Run

## Implementations

source

### impl NonZeroI8

1.34.0 (const: 1.34.0) · source

#### pub const unsafe fn new_unchecked(n: i8) -> 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.

1.34.0 (const: 1.47.0) · source

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

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

1.34.0 (const: 1.34.0) · source

#### pub const fn get(self) -> i8

Returns the value as a primitive type.

source

### impl NonZeroI8

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

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

Run
source

### impl NonZeroI8

source

#### pub const fn abs(self) -> NonZeroI8

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

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

##### Example

    #![feature(nonzero_ops)]

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

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

Run
source

#### pub const fn checked_abs(self) -> Option<NonZeroI8>

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

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

##### Example

    #![feature(nonzero_ops)]

    let pos = NonZeroI8::new(1)?;
    let neg = NonZeroI8::new(-1)?;
    let min = NonZeroI8::new(i8::MIN)?;

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

Run
source

#### pub const fn overflowing_abs(self) -> (NonZeroI8, bool)

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

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

##### Example

    #![feature(nonzero_ops)]

    let pos = NonZeroI8::new(1)?;
    let neg = NonZeroI8::new(-1)?;
    let min = NonZeroI8::new(i8::MIN)?;

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

Run
source

#### pub const fn saturating_abs(self) -> NonZeroI8

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

Saturating absolute value, see `i8::saturating_abs`.

##### Example

    #![feature(nonzero_ops)]

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

#### pub const fn wrapping_abs(self) -> NonZeroI8

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

Wrapping absolute value, see `i8::wrapping_abs`.

##### Example

    #![feature(nonzero_ops)]

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

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

Run
source

#### pub const fn unsigned_abs(self) -> NonZeroU8

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

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

##### Example

    #![feature(nonzero_ops)]

    let u_pos = NonZeroU8::new(1)?;
    let i_pos = NonZeroI8::new(1)?;
    let i_neg = NonZeroI8::new(-1)?;
    let i_min = NonZeroI8::new(i8::MIN)?;
    let u_max = NonZeroU8::new(u8::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

### impl NonZeroI8

source

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

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

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

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

Run
source

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

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

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

##### Examples

    #![feature(nonzero_ops)]

    let two = NonZeroI8::new(2)?;
    let four = NonZeroI8::new(4)?;
    let max = NonZeroI8::new(i8::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: NonZeroI8) -> NonZeroI8

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

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

##### Examples

    #![feature(nonzero_ops)]

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

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

Run
source

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

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

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

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

Run
source

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

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

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

##### Examples

    #![feature(nonzero_ops)]

    let three = NonZeroI8::new(3)?;
    let twenty_seven = NonZeroI8::new(27)?;
    let max = NonZeroI8::new(i8::MAX)?;

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

Run

## Trait Implementations

source

### impl Binary for NonZeroI8

source

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

Formats the value using the given formatter.

1.45.0 (const: unstable) · source

### impl BitOr<NonZeroI8> for NonZeroI8

#### type Output = Self

The resulting type after applying the `|` operator.

source

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

Performs the `|` operation. Read more

1.45.0 (const: unstable) · source

### impl BitOr<NonZeroI8> for i8

#### type Output = NonZeroI8

The resulting type after applying the `|` operator.

source

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

Performs the `|` operation. Read more

1.45.0 (const: unstable) · source

### impl BitOr<i8> for NonZeroI8

#### type Output = Self

The resulting type after applying the `|` operator.

source

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

Performs the `|` operation. Read more

1.45.0 (const: unstable) · source

### impl BitOrAssign<NonZeroI8> for NonZeroI8

source

#### fn bitor_assign(&mut self, rhs: Self)

Performs the `|=` operation. Read more

1.45.0 (const: unstable) · source

### impl BitOrAssign<i8> for NonZeroI8

source

#### fn bitor_assign(&mut self, rhs: i8)

Performs the `|=` operation. Read more

source

### impl Clone for NonZeroI8

source

#### fn clone(&self) -> NonZeroI8

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 NonZeroI8

source

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

Formats the value using the given formatter. Read more

source

### impl Display for NonZeroI8

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<NonZeroI8> for i8

source

#### fn from(nonzero: NonZeroI8) -> Self

Converts a `NonZeroI8` into an `i8`

1.41.0 (const: unstable) · source

### impl From<NonZeroI8> for NonZeroI16

source

#### fn from(small: NonZeroI8) -> Self

Converts `NonZeroI8` to `NonZeroI16` losslessly.

1.41.0 (const: unstable) · source

### impl From<NonZeroI8> for NonZeroI32

source

#### fn from(small: NonZeroI8) -> Self

Converts `NonZeroI8` to `NonZeroI32` losslessly.

1.41.0 (const: unstable) · source

### impl From<NonZeroI8> for NonZeroI64

source

#### fn from(small: NonZeroI8) -> Self

Converts `NonZeroI8` to `NonZeroI64` losslessly.

1.41.0 (const: unstable) · source

### impl From<NonZeroI8> for NonZeroI128

source

#### fn from(small: NonZeroI8) -> Self

Converts `NonZeroI8` to `NonZeroI128` losslessly.

1.41.0 (const: unstable) · source

### impl From<NonZeroI8> for NonZeroIsize

source

#### fn from(small: NonZeroI8) -> Self

Converts `NonZeroI8` to `NonZeroIsize` losslessly.

1.35.0 · source

### impl FromStr for NonZeroI8

#### 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 NonZeroI8

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 NonZeroI8

source

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

Formats the value using the given formatter.

source

### impl Octal for NonZeroI8

source

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

Formats the value using the given formatter.

source

### impl Ord for NonZeroI8

source

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

This method returns an `Ordering` between `self` and `other`. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

### impl PartialEq<NonZeroI8> for NonZeroI8

source

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

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

source

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

This method tests for `!=`.

source

### impl PartialOrd<NonZeroI8> for NonZeroI8

source

#### fn partial_cmp(&self, other: &NonZeroI8) -> 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 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<NonZeroI16> for NonZeroI8

source

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

Attempts to convert `NonZeroI16` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroI32> for NonZeroI8

source

#### 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.

1.49.0 · source

### impl TryFrom<NonZeroI64> for NonZeroI8

source

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

Attempts to convert `NonZeroI64` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroI8> for NonZeroU8

source

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

Attempts to convert `NonZeroI8` to `NonZeroU8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroI8> for NonZeroU16

source

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

Attempts to convert `NonZeroI8` to `NonZeroU16`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroI8> for NonZeroU32

source

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

Attempts to convert `NonZeroI8` to `NonZeroU32`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroI8> for NonZeroU64

source

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

Attempts to convert `NonZeroI8` to `NonZeroU64`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroI8> for NonZeroU128

source

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

Attempts to convert `NonZeroI8` to `NonZeroU128`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroI8> for NonZeroUsize

source

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

Attempts to convert `NonZeroI8` to `NonZeroUsize`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroIsize> for NonZeroI8

source

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

Attempts to convert `NonZeroIsize` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroU128> for NonZeroI8

source

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

Attempts to convert `NonZeroU128` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroU16> for NonZeroI8

source

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

Attempts to convert `NonZeroU16` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroU32> for NonZeroI8

source

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

Attempts to convert `NonZeroU32` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroU64> for NonZeroI8

source

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

Attempts to convert `NonZeroU64` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroU8> for NonZeroI8

source

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

Attempts to convert `NonZeroU8` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.49.0 · source

### impl TryFrom<NonZeroUsize> for NonZeroI8

source

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

Attempts to convert `NonZeroUsize` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

1.46.0 · source

### impl TryFrom<i8> for NonZeroI8

source

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

Attempts to convert `i8` to `NonZeroI8`.

#### type Error = TryFromIntError

The type returned in the event of a conversion error.

source

### impl UpperHex for NonZeroI8

source

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

Formats the value using the given formatter.

source

### impl Copy for NonZeroI8

source

### impl Eq for NonZeroI8

source

### impl StructuralEq for NonZeroI8

source

### impl StructuralPartialEq for NonZeroI8

## Auto Trait Implementations

### impl RefUnwindSafe for NonZeroI8

### impl Send for NonZeroI8

### impl Sync for NonZeroI8

### impl Unpin for NonZeroI8

### impl UnwindSafe for NonZeroI8

## Blanket Implementations

source

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

source

#### pub fn type_id(&Self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

source

#### pub fn borrow(&Self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

source

#### pub fn borrow_mut(&mut Self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

source

#### pub fn from(T) -> T

Performs the conversion.

source

### impl<T, U> Into<U> for T where
U: From<T>,

source

#### pub fn into(Self) -> U

Performs the conversion.

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

source

#### pub fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.