Enum NonZeroSign 

pub enum NonZeroSign {
    Positive = 1,
    Negative = -1,
}

Sign of a nonzero value.

Existing Sign traits, such in num, typically have a third value for the sign of 0. Working with that trait creates many branches or match cases that should never be possible.

Variants

Positive = 1

x > 0

Negative = -1

x < 0

Trait Implementations

impl Clone for NonZeroSign

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NonZeroSign

impl Debug for NonZeroSign

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

Formats the value using the given formatter.

impl Eq for NonZeroSign

impl From<NonZeroSign> for Sign

fn from(sign: NonZeroSign) -> Self

Converts to this type from the input type.

impl From<Sign> for NonZeroSign

fn from(other: Sign) -> Self

Converts to this type from the input type.

impl Mul for NonZeroSign

type Output = NonZeroSign

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for NonZeroSign

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for NonZeroSign

type Output = NonZeroSign

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Negateable for NonZeroSign

fn negate(&mut self)

Negate the number, e.g. go from 1 to -1.

impl NonZero for NonZeroSign

fn is_not_zero(&self) -> bool

Whether the value is not equal to zero.

impl Not for NonZeroSign

type Output = NonZeroSign

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for NonZeroSign

Signs are totally ordered as Negative < Positive, matching the discriminants.

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for NonZeroSign

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NonZeroSign

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Signed for NonZeroSign

fn signum(&self) -> Sign

Returns the sign of the number.

fn is_positive(&self) -> bool

Whether the number is (strictly) greater than zero.

fn is_negative(&self) -> bool

Whether the number is (strictly) smaller than zero.

impl StructuralPartialEq for NonZeroSign