Struct FiniteFloat 

pub struct FiniteFloat<T>(/* private fields */)
where
    T: PartialOrd + Copy;

A finite float (no NaN or infinity).

Example

use rusdantic_types::FiniteFloat;
let f = FiniteFloat::<f64>::new(3.14).unwrap();
assert_eq!(*f, 3.14);
assert!(FiniteFloat::<f64>::new(f64::NAN).is_err());
assert!(FiniteFloat::<f64>::new(f64::INFINITY).is_err());

Implementations

impl FiniteFloat<f64>

pub fn new(value: f64) -> Result<FiniteFloat<f64>, String>

Create a new finite f64, rejecting NaN and infinity.

pub fn into_inner(self) -> f64

Get the inner value.

impl FiniteFloat<f32>

pub fn new(value: f32) -> Result<FiniteFloat<f32>, String>

Create a new finite f32, rejecting NaN and infinity.

pub fn into_inner(self) -> f32

Get the inner value.

Trait Implementations

impl<T> Clone for FiniteFloat<T>

where T: Clone + PartialOrd + Copy,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for FiniteFloat<T>

where T: PartialOrd + Copy + Debug,

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

Formats the value using the given formatter.

impl<T> Deref for FiniteFloat<T>

where T: PartialOrd + Copy,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'de> Deserialize<'de> for FiniteFloat<f32>

fn deserialize<D>( deserializer: D, ) -> Result<FiniteFloat<f32>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for FiniteFloat<f64>

fn deserialize<D>( deserializer: D, ) -> Result<FiniteFloat<f64>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for FiniteFloat<T>

where T: PartialOrd + Copy + Display,

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

Formats the value using the given formatter.

impl<T> PartialEq for FiniteFloat<T>

where T: PartialEq + PartialOrd + Copy,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for FiniteFloat<T>

where T: PartialOrd + Copy,

fn partial_cmp(&self, other: &FiniteFloat<T>) -> 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<T> Serialize for FiniteFloat<T>

where T: PartialOrd + Copy + Serialize,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Copy for FiniteFloat<T>

where T: Copy + PartialOrd,

impl<T> StructuralPartialEq for FiniteFloat<T>

where T: PartialOrd + Copy,