Struct ssb_json_msg_data::LegacyF64

pub struct LegacyF64(_);

A wrapper around f64 to indicate that the float is compatible with the ssb legacy message data model, i.e. it is neither an infinity, nor -0.0, nor a NaN.

Because a LegacyF64 is never NaN, it can implement Eq and Ord, which regular f64 can not.

To obtain the inner value, use the From<LegacyF64> for f64 impl.

Methods

impl LegacyF64

pub fn from_f64(f: f64) -> Option<LegacyF64>

Safe conversion of an arbitrary f64 into a LegacyF64.

use ssb_json_msg_data::LegacyF64;

assert!(LegacyF64::from_f64(0.0).is_some());
assert!(LegacyF64::from_f64(-1.1).is_some());
assert!(LegacyF64::from_f64(-0.0).is_none());
assert!(LegacyF64::from_f64(std::f64::INFINITY).is_none());
assert!(LegacyF64::from_f64(std::f64::NEG_INFINITY).is_none());
assert!(LegacyF64::from_f64(std::f64::NAN).is_none());

pub unsafe fn from_f64_unchecked(f: f64) -> LegacyF64

Wraps the given f64 as a LegacyF64 without checking if it is valid.

When the debug_assertions feature is enabled (when compiling without optimizations), this function panics when given an invalid f64.

Safety

You must not pass infinity, negative infinity, negative zero or a NaN to this function. Any method on the resulting LegacyF64 could panic or exhibit undefined behavior.

use ssb_json_msg_data::LegacyF64;

let fine = unsafe { LegacyF64::from_f64_unchecked(1.1) };

// Never do this:
// let everything_is_terrible = unsafe { LegacyF64::from_f64_unchecked(-0.0) };

pub fn is_valid(f: f64) -> bool

Checks whether a given f64 may be used as a LegacyF64.

Trait Implementations

impl Clone for LegacyF64

fn clone(&self) -> LegacyF64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for LegacyF64

impl Debug for LegacyF64

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

Formats the value using the given formatter.

impl Default for LegacyF64

fn default() -> LegacyF64

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for LegacyF64

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for LegacyF64

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

Formats the value using the given formatter.

impl Eq for LegacyF64

impl From<LegacyF64> for f64

fn from(f: LegacyF64) -> Self

Performs the conversion.

impl Ord for LegacyF64

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 PartialEq<LegacyF64> for LegacyF64

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

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

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

This method tests for !=.

impl PartialOrd<LegacyF64> for LegacyF64

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

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

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

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

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

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

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

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

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

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

impl Serialize for LegacyF64

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LegacyF64