Struct ijson::number::INumber

#[repr(transparent)]pub struct INumber(_);

The INumber type represents a JSON number. It is decoupled from any specific representation, and internally uses several. There is no way to determine the internal representation: instead the caller is expected to convert the number using one of the fallible to_xxx functions and handle the cases where the number does not convert to the desired type.

Special floating point values (eg. NaN, Infinity, etc.) cannot be stored within an INumber.

Whilst INumber does not consider 2.0 and 2 to be different numbers (ie. they will compare equal) it does allow you to distinguish them using the method INumber::has_decimal_point(). That said, calling to_i32 on 2.0 will succeed with the value 2.

Currently INumber can store any number representable with an f64, i64 or u64. It is expected that in the future it will be further expanded to store integers and possibly decimals to arbitrary precision, but that is not currently the case.

Any number representable with an i8 or a u8 can be stored in an INumber without a heap allocation (so JSON byte arrays are relatively efficient). Integers up to 24 bits can be stored with a 4-byte heap allocation.

Implementations

impl INumber

pub fn zero() -> Self

Returns the number zero (without a decimal point). Does not allocate.

pub fn one() -> Self

Returns the number one (without a decimal point). Does not allocate.

pub fn to_i64(&self) -> Option<i64>

Converts this number to an i64 if it can be represented exactly.

pub fn to_u64(&self) -> Option<u64>

Converts this number to an f64 if it can be represented exactly.

pub fn to_f64(&self) -> Option<f64>

Converts this number to an f64 if it can be represented exactly.

pub fn to_f32(&self) -> Option<f32>

Converts this number to an f32 if it can be represented exactly.

pub fn to_i32(&self) -> Option<i32>

Converts this number to an i32 if it can be represented exactly.

pub fn to_u32(&self) -> Option<u32>

Converts this number to a u32 if it can be represented exactly.

pub fn to_isize(&self) -> Option<isize>

Converts this number to an isize if it can be represented exactly.

pub fn to_usize(&self) -> Option<usize>

Converts this number to a usize if it can be represented exactly.

pub fn to_f64_lossy(&self) -> f64

Converts this number to an f64, potentially losing precision in the process.

pub fn to_f32_lossy(&self) -> f32

Converts this number to an f32, potentially losing precision in the process.

pub fn has_decimal_point(&self) -> bool

This allows distinguishing between 1.0 and 1 in the original JSON. Numeric operations will otherwise treat these two values as equivalent.

Trait Implementations

impl AsMut<IValue> for INumber

pub fn as_mut(&mut self) -> &mut IValue

Performs the conversion.

impl AsRef<IValue> for INumber

pub fn as_ref(&self) -> &IValue

Performs the conversion.

impl Borrow<IValue> for INumber

pub fn borrow(&self) -> &IValue

Immutably borrows from an owned value.

impl BorrowMut<IValue> for INumber

pub fn borrow_mut(&mut self) -> &mut IValue

Mutably borrows from an owned value.

impl Clone for INumber

pub fn clone(&self) -> INumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for INumber

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

Formats the value using the given formatter.

impl Default for INumber

pub fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for INumber

pub fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for &'de INumber

type Error = Error

The error type that can be returned if some error occurs during deserialization.

pub fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

pub fn deserialize_newtype_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a newtype struct with a particular name.

pub fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a bool value.

pub fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i8 value.

pub fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i16 value.

pub fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i32 value.

pub fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i64 value.

pub fn deserialize_i128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i128 value.

pub fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u8 value.

pub fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u16 value.

pub fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u32 value.

pub fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u64 value.

pub fn deserialize_u128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an u128 value.

pub fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f32 value.

pub fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f64 value.

pub fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a char value.

pub fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

pub fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

pub fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

pub fn deserialize_byte_buf<V>(
    self,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

pub fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an optional value.

pub fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit value.

pub fn deserialize_unit_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit struct with a particular name.

pub fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a sequence of values.

pub fn deserialize_tuple<V>(
    self,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

pub fn deserialize_tuple_struct<V>(
    self,
    name: &'static str,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

pub fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a map of key-value pairs.

pub fn deserialize_struct<V>(
    self,
    name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a struct with a particular name and fields.

pub fn deserialize_enum<V>(
    self,
    name: &'static str,
    variants: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

pub fn deserialize_identifier<V>(
    self,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

pub fn deserialize_ignored_any<V>(
    self,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type needs to deserialize a value whose type doesn't matter because it is ignored.

pub fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl Eq for INumber

impl From<INumber> for IValue

pub fn from(other: INumber) -> Self

Performs the conversion.

impl From<i16> for INumber

pub fn from(v: i16) -> Self

Performs the conversion.

impl From<i32> for INumber

pub fn from(v: i32) -> Self

Performs the conversion.

impl From<i64> for INumber

pub fn from(v: i64) -> Self

Performs the conversion.

impl From<i8> for INumber

pub fn from(v: i8) -> Self

Performs the conversion.

impl From<isize> for INumber

pub fn from(v: isize) -> Self

Performs the conversion.

impl From<u16> for INumber

pub fn from(v: u16) -> Self

Performs the conversion.

impl From<u32> for INumber

pub fn from(v: u32) -> Self

Performs the conversion.

impl From<u64> for INumber

pub fn from(v: u64) -> Self

Performs the conversion.

impl From<u8> for INumber

pub fn from(v: u8) -> Self

Performs the conversion.

impl From<usize> for INumber

pub fn from(v: usize) -> Self

Performs the conversion.

impl Hash for INumber

pub fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for INumber

pub fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub 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<INumber> for INumber

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<INumber> for INumber

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Serialize for INumber

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

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a IValue> for &'a INumber

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(other: &'a IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a mut IValue> for &'a mut INumber

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(other: &'a mut IValue) -> Result<Self, ()>

Performs the conversion.

impl TryFrom<IValue> for INumber

type Error = IValue

The type returned in the event of a conversion error.

pub fn try_from(other: IValue) -> Result<Self, IValue>

Performs the conversion.

impl TryFrom<f32> for INumber

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(v: f32) -> Result<Self, ()>

Performs the conversion.

impl TryFrom<f64> for INumber

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(v: f64) -> Result<Self, ()>

Performs the conversion.