Trait NonZeroPrimitiveSigned 

pub trait NonZeroPrimitiveSigned:
    NonZeroPrimitiveInteger<Integer: PrimitiveSigned>
    + From<NonZero<i8>>
    + Neg<Output = Self> {
    type NonZeroUnsigned: NonZeroPrimitiveUnsigned;

    // Required methods
    fn abs(self) -> Self;
    fn cast_unsigned(self) -> Self::NonZeroUnsigned;
    fn checked_abs(self) -> Option<Self>;
    fn checked_neg(self) -> Option<Self>;
    fn is_positive(self) -> bool;
    fn is_negative(self) -> bool;
    fn overflowing_abs(self) -> (Self, bool);
    fn overflowing_neg(self) -> (Self, bool);
    fn saturating_abs(self) -> Self;
    fn saturating_neg(self) -> Self;
    fn unsigned_abs(self) -> Self::NonZeroUnsigned;
    fn wrapping_abs(self) -> Self;
    fn wrapping_neg(self) -> Self;
}

Trait for NonZero primitive signed integers, including the supertrait NonZeroPrimitiveInteger.

This encapsulates trait implementations and inherent methods that are common among all of the implementations of NonZero<T>, where T is a PrimitiveSigned.

See the corresponding items on the individual types for more documentation and examples.

This trait is sealed with a private trait to prevent downstream implementations, so we may continue to expand along with the standard library without worrying about breaking changes for implementors.

Examples

use num_primitive::NonZeroPrimitiveSigned;
use core::num::NonZero;

fn sign_and_magnitude<T: NonZeroPrimitiveSigned>(n: T) -> (bool, T::NonZeroUnsigned) {
    (n.is_negative(), n.unsigned_abs())
}

let n = NonZero::new(-42i16).unwrap();
assert_eq!(sign_and_magnitude(n), (true, NonZero::new(42u16).unwrap()));

Required Associated Types

type NonZeroUnsigned: NonZeroPrimitiveUnsigned

The unsigned non-zero integer type used by methods like cast_unsigned.

For core::num::NonZero<T>, this is NonZero<T::Unsigned>.

Required Methods

fn abs(self) -> Self

Computes the absolute value of self.

fn cast_unsigned(self) -> Self::NonZeroUnsigned

Returns the bit pattern of self reinterpreted as an unsigned integer of the same size.

fn checked_abs(self) -> Option<Self>

Checked absolute value. Checks for overflow and returns None if self == Self::MIN.

fn checked_neg(self) -> Option<Self>

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

fn is_positive(self) -> bool

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

fn is_negative(self) -> bool

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

fn overflowing_abs(self) -> (Self, bool)

Computes the absolute value of self, with overflow information.

fn overflowing_neg(self) -> (Self, bool)

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

fn saturating_abs(self) -> Self

Saturating absolute value.

fn saturating_neg(self) -> Self

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

fn unsigned_abs(self) -> Self::NonZeroUnsigned

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

fn wrapping_abs(self) -> Self

Wrapping absolute value.

fn wrapping_neg(self) -> Self

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

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl NonZeroPrimitiveSigned for NonZero<i8>

fn abs(self) -> Self

See the inherent abs method.

fn cast_unsigned(self) -> Self::NonZeroUnsigned

See the inherent cast_unsigned method.

fn checked_abs(self) -> Option<Self>

See the inherent checked_abs method.

fn checked_neg(self) -> Option<Self>

See the inherent checked_neg method.

fn is_negative(self) -> bool

See the inherent is_negative method.

fn is_positive(self) -> bool

See the inherent is_positive method.

fn overflowing_abs(self) -> (Self, bool)

See the inherent overflowing_abs method.

fn overflowing_neg(self) -> (Self, bool)

See the inherent overflowing_neg method.

fn saturating_abs(self) -> Self

See the inherent saturating_abs method.

fn saturating_neg(self) -> Self

See the inherent saturating_neg method.

fn unsigned_abs(self) -> Self::NonZeroUnsigned

See the inherent unsigned_abs method.

fn wrapping_abs(self) -> Self

See the inherent wrapping_abs method.

fn wrapping_neg(self) -> Self

See the inherent wrapping_neg method.

type NonZeroUnsigned = NonZero<u8>

impl NonZeroPrimitiveSigned for NonZero<i16>

fn abs(self) -> Self

See the inherent abs method.

fn cast_unsigned(self) -> Self::NonZeroUnsigned

See the inherent cast_unsigned method.

fn checked_abs(self) -> Option<Self>

See the inherent checked_abs method.

fn checked_neg(self) -> Option<Self>

See the inherent checked_neg method.

fn is_negative(self) -> bool

See the inherent is_negative method.

fn is_positive(self) -> bool

See the inherent is_positive method.

fn overflowing_abs(self) -> (Self, bool)

See the inherent overflowing_abs method.

fn overflowing_neg(self) -> (Self, bool)

See the inherent overflowing_neg method.

fn saturating_abs(self) -> Self

See the inherent saturating_abs method.

fn saturating_neg(self) -> Self

See the inherent saturating_neg method.

fn unsigned_abs(self) -> Self::NonZeroUnsigned

See the inherent unsigned_abs method.

fn wrapping_abs(self) -> Self

See the inherent wrapping_abs method.

fn wrapping_neg(self) -> Self

See the inherent wrapping_neg method.

type NonZeroUnsigned = NonZero<u16>

impl NonZeroPrimitiveSigned for NonZero<i32>

fn abs(self) -> Self

See the inherent abs method.

fn cast_unsigned(self) -> Self::NonZeroUnsigned

See the inherent cast_unsigned method.

fn checked_abs(self) -> Option<Self>

See the inherent checked_abs method.

fn checked_neg(self) -> Option<Self>

See the inherent checked_neg method.

fn is_negative(self) -> bool

See the inherent is_negative method.

fn is_positive(self) -> bool

See the inherent is_positive method.

fn overflowing_abs(self) -> (Self, bool)

See the inherent overflowing_abs method.

fn overflowing_neg(self) -> (Self, bool)

See the inherent overflowing_neg method.

fn saturating_abs(self) -> Self

See the inherent saturating_abs method.

fn saturating_neg(self) -> Self

See the inherent saturating_neg method.

fn unsigned_abs(self) -> Self::NonZeroUnsigned

See the inherent unsigned_abs method.

fn wrapping_abs(self) -> Self

See the inherent wrapping_abs method.

fn wrapping_neg(self) -> Self

See the inherent wrapping_neg method.

type NonZeroUnsigned = NonZero<u32>

impl NonZeroPrimitiveSigned for NonZero<i64>

fn abs(self) -> Self

See the inherent abs method.

fn cast_unsigned(self) -> Self::NonZeroUnsigned

See the inherent cast_unsigned method.

fn checked_abs(self) -> Option<Self>

See the inherent checked_abs method.

fn checked_neg(self) -> Option<Self>

See the inherent checked_neg method.

fn is_negative(self) -> bool

See the inherent is_negative method.

fn is_positive(self) -> bool

See the inherent is_positive method.

fn overflowing_abs(self) -> (Self, bool)

See the inherent overflowing_abs method.

fn overflowing_neg(self) -> (Self, bool)

See the inherent overflowing_neg method.

fn saturating_abs(self) -> Self

See the inherent saturating_abs method.

fn saturating_neg(self) -> Self

See the inherent saturating_neg method.

fn unsigned_abs(self) -> Self::NonZeroUnsigned

See the inherent unsigned_abs method.

fn wrapping_abs(self) -> Self

See the inherent wrapping_abs method.

fn wrapping_neg(self) -> Self

See the inherent wrapping_neg method.

type NonZeroUnsigned = NonZero<u64>

impl NonZeroPrimitiveSigned for NonZero<i128>

fn abs(self) -> Self

See the inherent abs method.

fn cast_unsigned(self) -> Self::NonZeroUnsigned

See the inherent cast_unsigned method.

fn checked_abs(self) -> Option<Self>

See the inherent checked_abs method.

fn checked_neg(self) -> Option<Self>

See the inherent checked_neg method.

fn is_negative(self) -> bool

See the inherent is_negative method.

fn is_positive(self) -> bool

See the inherent is_positive method.

fn overflowing_abs(self) -> (Self, bool)

See the inherent overflowing_abs method.

fn overflowing_neg(self) -> (Self, bool)

See the inherent overflowing_neg method.

fn saturating_abs(self) -> Self

See the inherent saturating_abs method.

fn saturating_neg(self) -> Self

See the inherent saturating_neg method.

fn unsigned_abs(self) -> Self::NonZeroUnsigned

See the inherent unsigned_abs method.

fn wrapping_abs(self) -> Self

See the inherent wrapping_abs method.

fn wrapping_neg(self) -> Self

See the inherent wrapping_neg method.

type NonZeroUnsigned = NonZero<u128>

impl NonZeroPrimitiveSigned for NonZero<isize>

fn abs(self) -> Self

See the inherent abs method.

fn cast_unsigned(self) -> Self::NonZeroUnsigned

See the inherent cast_unsigned method.

fn checked_abs(self) -> Option<Self>

See the inherent checked_abs method.

fn checked_neg(self) -> Option<Self>

See the inherent checked_neg method.

fn is_negative(self) -> bool

See the inherent is_negative method.

fn is_positive(self) -> bool

See the inherent is_positive method.

fn overflowing_abs(self) -> (Self, bool)

See the inherent overflowing_abs method.

fn overflowing_neg(self) -> (Self, bool)

See the inherent overflowing_neg method.

fn saturating_abs(self) -> Self

See the inherent saturating_abs method.

fn saturating_neg(self) -> Self

See the inherent saturating_neg method.

fn unsigned_abs(self) -> Self::NonZeroUnsigned

See the inherent unsigned_abs method.

fn wrapping_abs(self) -> Self

See the inherent wrapping_abs method.

fn wrapping_neg(self) -> Self

See the inherent wrapping_neg method.

type NonZeroUnsigned = NonZero<usize>

Implementors