Enum infinitable::Infinitable

pub enum Infinitable<T> {
    Finite(T),
    Infinity,
    NegativeInfinity,
}

An "infinitable" value, one that can be either finite or infinite

Variants

Finite(T)

A finite value T

Infinity

Positive infinity, which compares greater than all finite values

NegativeInfinity

Negative infinity, which compares less than all finite values

Methods

impl<T> Infinitable<T>

pub fn is_finite(&self) -> bool

Returns true if the value is Finite.

Examples

use infinitable::Finite;

let finite = Finite(5);
assert!(finite.is_finite());

pub fn finite(self) -> Option<T>

Converts from an Infinitable<T> to an Option<T>.

Converts self into an Option<T> possibly containing a finite value, consuming self.

Examples

use infinitable::*;

let finite = Finite(5);
assert_eq!(Some(5), finite.finite());
let infinite: Infinitable<i32> = Infinity;
assert_eq!(None, infinite.finite());

pub fn finite_or_infinity(option: Option<T>) -> Infinitable<T>

Converts from an Option<T> to either Finite or Infinity.

Converts an Option<T> to an Infinitable<T>. Some(T) is converted to Finite(T), and None is converted to Infinity.

Examples

use infinitable::*;

let finite = Finite(5);
assert_eq!(finite, Infinitable::finite_or_infinity(Some(5)));
let infinite: Infinitable<i32> = Infinity;
assert_eq!(infinite, Infinitable::finite_or_infinity(None));

pub fn finite_or_negative_infinity(option: Option<T>) -> Infinitable<T>

Converts from an Option<T> to either Finite or NegativeInfinity.

Converts an Option<T> to an Infinitable<T>. Some(T) is converted to Finite(T), and None is converted to NegativeInfinity.

Examples

use infinitable::*;

let finite = Finite(5);
assert_eq!(finite, Infinitable::finite_or_negative_infinity(Some(5)));
let infinite: Infinitable<i32> = NegativeInfinity;
assert_eq!(infinite, Infinitable::finite_or_negative_infinity(None));

Trait Implementations

impl<T: Clone> Clone for Infinitable<T>

fn clone(&self) -> Infinitable<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Infinitable<T>

impl<T: Debug> Debug for Infinitable<T>

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

Formats the value using the given formatter.

impl<T> Display for Infinitable<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Infinitable<T>

impl<T> From<T> for Infinitable<T>

fn from(value: T) -> Infinitable<T>

Performs the conversion.

impl<T: Hash> Hash for Infinitable<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

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<T> Neg for Infinitable<T> where
    T: Neg, 

type Output = Infinitable<T::Output>

The resulting type after applying the - operator.

fn neg(self) -> Infinitable<T::Output>

Performs the unary - operation.

impl<T> Ord for Infinitable<T> where
    T: Ord, 

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Infinitable<T>> for Infinitable<T>

fn eq(&self, other: &Infinitable<T>) -> bool

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

fn ne(&self, other: &Infinitable<T>) -> bool

This method tests for !=.

impl<T> PartialOrd<Infinitable<T>> for Infinitable<T> where
    T: PartialOrd, 

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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<T> StructuralEq for Infinitable<T>

impl<T> StructuralPartialEq for Infinitable<T>