Struct Float

pub struct Float(/* private fields */);

A wrapper for f64, which guarantees that the inner value is finite and thus implements Eq, Hash and Ord.

Implementations

impl Float

pub fn new(v: f64) -> Self

Construct a new Float.

pub fn get(self) -> f64

Returns the wrapped float.

Trait Implementations

impl Clone for Float

fn clone(&self) -> Float

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Float

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

Formats the value using the given formatter.

impl Hash for Float

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

Feeds a slice of this type into the given Hasher.

impl Ord for Float

Ordering comparison In order to be able to use Float as a mapping key, NaN floating values wrapped in Float are equal to each other and are less then any other floating value. It is not the case for underlying f64 values itself. See the PartialEq implementation.

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.

impl PartialEq for Float

Partial equality comparison In order to be able to use Number as a mapping key, NaN floating values wrapped in Float are equal to each other. It is not the case for underlying f64 values itself.

fn eq(&self, other: &Self) -> 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 PartialOrd for Float

Partial ordering comparison In order to be able to use Number as a mapping key, NaN floating values wrapped in Number are equal to each other and are less then any other floating value. It is not the case for the underlying f64 values themselves.

use ron::value::Number;
assert!(Number::new(std::f64::NAN) < Number::new(std::f64::NEG_INFINITY));
assert_eq!(Number::new(std::f64::NAN), Number::new(std::f64::NAN));

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 Copy for Float

impl Eq for Float

Equality comparison In order to be able to use Float as a mapping key, NaN floating values wrapped in Float are equal to each other. It is not the case for underlying f64 values itself.