Enum rsonpath_syntax::num::JsonNumber

pub enum JsonNumber {
    Int(JsonInt),
    Float(JsonFloat),
}

JSONPath numeric type - either a JsonInt or a JsonFloat.

Note that this type is not normalized and an integer in the range [-2⁵³+1, (2⁵³)-1] can be represented both as a JsonNumber::Int and as a JsonNumber::Float.

Which type is produced when is a parser implementation detail. If you need to rely on integers always being represented as JsonNumber::Int you can use JsonNumber::normalize, or manually inspect the underlying JsonFloat using JsonFloat::is_int and its TryInto<JsonInt> conversion.

Examples

let int = JsonInt::from(42);
let float = JsonFloat::try_from(42.01).unwrap();

let num_int = JsonNumber::from(int);
let num_float = JsonNumber::from(float);

assert_eq!(num_int, JsonNumber::Int(int));
assert_eq!(num_float, JsonNumber::Float(float));
assert_eq!("42", num_int.to_string());
assert_eq!("42.01", num_float.to_string());

Variants

Int(JsonInt)

A JsonInt number.

Float(JsonFloat)

A JsonFloat number.

Implementations

impl JsonNumber

pub fn normalize(&self) -> Self

Normalize a JsonNumber so that valid JsonInt value is represented by JsonNumber::Int.

The parser is allowed to represent a normal JSON integer (e.g. 17) as an equivalent JSON float (17.0). Calling normalize ensures all values representable by a JsonInt are indeed represented as such.

Examples

// Creating a JsonNumber from a JsonFloat always gives JsonNumber::Float.
let f1 = JsonFloat::try_from(17.0).unwrap();
let nf1 = JsonNumber::from(f1);
assert_eq!(nf1, JsonNumber::Float(f1));
// Normalizing will give us an integer representation, when possible.
assert_eq!(nf1.normalize(), JsonNumber::Int(17.into()));

// If the float is an integer within range normalization will succeed.
let f2 = JsonFloat::try_from(1e15).unwrap();
let nf2 = JsonNumber::from(f2);
assert_eq!(nf2, JsonNumber::Float(f2));
assert_eq!(nf2.normalize(), JsonNumber::Int(1_000_000_000_000_000_i64.try_into().unwrap()));

// An int is an int, and remains so under normalization.
let i1 = JsonInt::from(42);
let ni1 = JsonNumber::from(i1);
assert_eq!(ni1, JsonNumber::Int(i1));
assert_eq!(ni1.normalize(), JsonNumber::Int(i1));

// A float that is not an int remains the same when normalized.
let f3 = JsonFloat::try_from(3.14).unwrap();
let nf3 = JsonNumber::from(f3);
assert_eq!(nf3, JsonNumber::Float(f3));
assert_eq!(nf3.normalize(), JsonNumber::Float(f3));

// A float that is an int, but outside of the interoperable JsonInt range,
// is not normalized.
let f4 = JsonFloat::try_from(1e120).unwrap();
let nf4 = JsonNumber::from(f4);
assert_eq!(nf4, JsonNumber::Float(f4));
assert_eq!(nf4.normalize(), JsonNumber::Float(f4));

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for JsonNumber

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

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

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

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 JsonNumber

fn clone(&self) -> JsonNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonNumber

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

Formats the value using the given formatter.

impl Display for JsonNumber

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<JsonInt> for JsonNumber

fn from(value: JsonInt) -> Self

Converts to this type from the input type.

impl From<JsonNumber> for Literal

fn from(value: JsonNumber) -> Self

Converts to this type from the input type.

impl Hash for JsonNumber

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 JsonNumber

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 JsonNumber

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

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

impl Eq for JsonNumber