Enum Sign 

#[repr(i8)]
pub enum Sign {
    Zero = 0,
    Positive = 1,
    Negative = -1,
}

A representation of a numeric sign.

Its Display impl emits the ASCII minus sign, -, when this is negative. It emits the empty string in all other cases.

Variants

Zero = 0

Positive = 1

Negative = -1

Implementations

impl Sign

pub const fn is_zero(self) -> bool

Returns true when the sign is Sign::Zero.

pub const fn is_positive(self) -> bool

Returns true when the sign is Sign::Positive.

pub const fn is_negative(self) -> bool

Returns true when the sign is Sign::Negative.

pub const fn signum(self) -> i8

Returns the sign as an i8.

This is guaranteed to be -1, 0 or 1.

pub const fn as_i8(self) -> i8

Returns the sign as an i8.

This is guaranteed to be -1, 0 or 1.

pub const fn as_i16(self) -> i16

Returns the sign as an i16.

This is guaranteed to be -1, 0 or 1.

pub const fn as_i32(self) -> i32

Returns the sign as an i32.

This is guaranteed to be -1, 0 or 1.

pub const fn as_i64(self) -> i64

Returns the sign as an i64.

This is guaranteed to be -1, 0 or 1.

pub const fn as_i128(self) -> i128

Returns the sign as an i128.

This is guaranteed to be -1, 0 or 1.

pub fn from_ordinals<T>(t1: T, t2: T) -> Sign

where T: Ord,

Returns a Sign as a result of comparing two values.

• When t1 < t2, returns Sign::Negative.
• When t1 == t2, returns Sign::Zero.
• When t1 > t2, returns Sign::Positive.

Trait Implementations

impl Clone for Sign

fn clone(&self) -> Sign

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Sign

impl Debug for Sign

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

Formats the value using the given formatter.

impl Default for Sign

fn default() -> Sign

Returns the “default value” for a type.

impl Display for Sign

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

Formats the value using the given formatter.

impl Eq for Sign

impl From<f64> for Sign

This considers NaN values as having a zero sign.

In general, Jiff having a NaN value in memory is a bug.

fn from(n: f64) -> Sign

Converts to this type from the input type.

impl From<i8> for Sign

fn from(n: i8) -> Sign

Converts to this type from the input type.

impl From<i16> for Sign

fn from(n: i16) -> Sign

Converts to this type from the input type.

impl From<i32> for Sign

fn from(n: i32) -> Sign

Converts to this type from the input type.

impl From<i64> for Sign

fn from(n: i64) -> Sign

Converts to this type from the input type.

impl From<i128> for Sign

fn from(n: i128) -> Sign

Converts to this type from the input type.

impl Hash for Sign

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul for Sign

type Output = Sign

The resulting type after applying the * operator.

fn mul(self, rhs: Sign) -> Sign

Performs the * operation.

impl Mul<Sign> for i8

type Output = i8

The resulting type after applying the * operator.

fn mul(self, n: Sign) -> i8

Performs the * operation.

impl Mul<Sign> for i16

type Output = i16

The resulting type after applying the * operator.

fn mul(self, n: Sign) -> i16

Performs the * operation.

impl Mul<Sign> for i32

type Output = i32

The resulting type after applying the * operator.

fn mul(self, n: Sign) -> i32

Performs the * operation.

impl Mul<Sign> for i64

type Output = i64

The resulting type after applying the * operator.

fn mul(self, n: Sign) -> i64

Performs the * operation.

impl Mul<Sign> for i128

type Output = i128

The resulting type after applying the * operator.

fn mul(self, n: Sign) -> i128

Performs the * operation.

impl Mul<i8> for Sign

type Output = i8

The resulting type after applying the * operator.

fn mul(self, n: i8) -> i8

Performs the * operation.

impl Mul<i16> for Sign

type Output = i16

The resulting type after applying the * operator.

fn mul(self, n: i16) -> i16

Performs the * operation.

impl Mul<i32> for Sign

type Output = i32

The resulting type after applying the * operator.

fn mul(self, n: i32) -> i32

Performs the * operation.

impl Mul<i64> for Sign

type Output = i64

The resulting type after applying the * operator.

fn mul(self, n: i64) -> i64

Performs the * operation.

impl Mul<i128> for Sign

type Output = i128

The resulting type after applying the * operator.

fn mul(self, n: i128) -> i128

Performs the * operation.

impl Neg for Sign

type Output = Sign

The resulting type after applying the - operator.

fn neg(self) -> Sign

Performs the unary - operation.

impl Ord for Sign

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Sign

fn partial_cmp(&self, other: &Sign) -> 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 StructuralPartialEq for Sign