Struct rsonpath_syntax::num::JsonFloat

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

IEEE 754 conformant floating-point number expressible in JSON.

These numbers behave as standard binary64 (double precision) numbers restricted as in the JSON specification, i.e. they cannot be NaN, +Inf, or -Inf.

These restrictions allow some “nice” properties - JsonFloat implements Eq and Ord, as well as Hash, and its binary representation is the same as a regular f64.

Integer conversions

Because of interoperability restrictions on JsonInt, any JsonInt losslessly converts to a JsonFloat and back. Therefore, JsonInt is Into<JsonFloat>, and JsonFloat is TryInto<JsonInt>, where the conversion succeeds if and only if the float is an exactly representable integer in the range [-2⁵³+1, (2⁵³)-1].

Implementations

impl JsonFloat

pub fn as_f64(&self) -> f64

Return the value stored as a f64.

Examples

let val = JsonFloat::try_from(3.14).unwrap();
assert_eq!(val.as_f64(), 3.14);

pub fn is_int(&self) -> bool

Check if this float is an equivalent of some JsonInt.

The range of valid JsonInt is exactly representable as JsonFloat values. This function returns true if the float is one of those valid values, i.e. an integer and in the JsonInt bounds.

Examples

let f1 = JsonFloat::try_from(3.0).unwrap();
let f2 = JsonFloat::try_from(3.14).unwrap();
let f3 = JsonFloat::try_from(1e54).unwrap();

assert!(f1.is_int());
assert!(!f2.is_int());
assert!(!f3.is_int());

Trait Implementations

impl<'a> Arbitrary<'a> for JsonFloat

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for JsonFloat

fn clone(&self) -> JsonFloat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonFloat

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

Formats the value using the given formatter.

impl Display for JsonFloat

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

Formats the value using the given formatter.

impl From<JsonFloat> for JsonNumber

fn from(value: JsonFloat) -> Self

Converts to this type from the input type.

impl From<JsonFloat> for Literal

fn from(value: JsonFloat) -> Self

Converts to this type from the input type.

impl From<JsonInt> for JsonFloat

fn from(value: JsonInt) -> Self

Converts to this type from the input type.

impl FromStr for JsonFloat

type Err = JsonFloatParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for JsonFloat

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 JsonFloat

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for JsonFloat

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

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

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

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

impl PartialOrd for JsonFloat

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

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

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

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

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

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

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 TryFrom<JsonFloat> for JsonInt

type Error = JsonIntOverflowError

The type returned in the event of a conversion error.

fn try_from(value: JsonFloat) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f32> for JsonFloat

type Error = JsonFloatConvertError

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for JsonFloat

type Error = JsonFloatConvertError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for JsonFloat

impl Eq for JsonFloat

impl StructuralPartialEq for JsonFloat