Struct JsonInt

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

Signed interoperable JSON integer.

Provides an IETF-conforming integer value Values are [-2⁵³+1, 2⁵³-1].

All values in a JSONPath query are limited to this range for interoperability (see RFC 2.1-4.1).

The unsigned version is JsonUInt.

Examples

let two = JsonInt::from(2);
let zero = JsonInt::from(0);
let negative = JsonInt::from(-2);

assert_eq!(two.as_i64(), 2);
assert_eq!(zero.as_i64(), 0);
assert_eq!(negative.as_i64(), -2);

let too_big = JsonInt::try_from(1_i64 << 53).expect_err("out of range");
let too_small = JsonInt::try_from(-(1_i64 << 53)).expect_err("out of range");

Implementations

impl JsonInt

pub const ZERO: Self

A constant value of zero. Equivalent to JsonInt::default.

Examples

assert_eq!(JsonInt::ZERO.as_i64(), 0);

pub const ONE: Self

A constant value of one.

Examples

assert_eq!(JsonInt::ONE.as_i64(), 1);

pub const MIN: Self

A constant for the smallest expressible value.

Examples

let min_i64 = -(1 << 53) + 1;

assert_eq!(JsonInt::MIN.as_i64(), min_i64);
assert_eq!(JsonInt::try_from(min_i64).expect("within range"), JsonInt::MIN);

pub const MAX: Self

A constant for the largest expressible value.

Examples

let max_i64 = (1 << 53) - 1;

assert_eq!(JsonInt::MAX.as_i64(), max_i64);
assert_eq!(JsonInt::try_from(max_i64).expect("within range"), JsonInt::MAX);

pub fn try_increment(&mut self) -> Result<(), JsonIntOverflowError>

Increase the integer by one.

Errors

Will return Err if the increment causes the JsonInt to exceed the upper limit of JsonInt::MAX.

Examples

let mut x = JsonInt::ZERO;
x.try_increment().expect("within range");
assert_eq!(x.as_i64(), 1);

let mut y = JsonInt::MIN;
y.try_increment().expect("within range");
assert_eq!(y.as_i64(), -(1 << 53) + 2);

JsonInt::MAX.try_increment().expect_err("out of range");

pub const fn as_i64(&self) -> i64

Return the value stored as a regular i64.

Examples

let val = JsonInt::from(42);
assert_eq!(val.as_i64(), 42);

pub const fn neg(&self) -> Self

Return the negation of the value.

This is guaranteed to succeed, as the valid range is symmetrical.

let x = JsonInt::from(-42);
assert_eq!(x.neg().as_i64(), 42);

pub const fn abs(&self) -> JsonUInt

Return the absolute value of this integer as a JsonUInt.

This is guaranteed to succeed, as the valid range is symmetrical.

Examples

let pos = JsonInt::from(42);
let neg = JsonInt::from(-42);
assert_eq!(neg.abs().as_u64(), 42);
assert_eq!(pos.abs().as_u64(), 42);

Trait Implementations

impl<'a> Arbitrary<'a> for JsonInt

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.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

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

impl Clone for JsonInt

fn clone(&self) -> JsonInt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonInt

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

Formats the value using the given formatter.

impl Default for JsonInt

fn default() -> JsonInt

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonInt

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JsonInt

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

Formats the value using the given formatter.

impl From<JsonInt> for JsonFloat

fn from(value: JsonInt) -> 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<JsonInt> for Literal

fn from(value: JsonInt) -> Self

Converts to this type from the input type.

impl From<JsonInt> for Step

fn from(value: JsonInt) -> Self

Converts to this type from the input type.

impl From<JsonInt> for i64

fn from(value: JsonInt) -> Self

Converts to this type from the input type.

impl From<JsonUInt> for JsonInt

fn from(value: JsonUInt) -> Self

Converts to this type from the input type.

impl From<i32> for JsonInt

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<u32> for JsonInt

fn from(value: u32) -> Self

Converts to this type from the input type.

impl FromStr for JsonInt

type Err = JsonIntParseError

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 JsonInt

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 JsonInt

fn cmp(&self, other: &JsonInt) -> 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 JsonInt

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

fn partial_cmp(&self, other: &JsonInt) -> 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 Serialize for JsonInt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

type Error = JsonIntOverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<i64> for JsonInt

type Error = JsonIntOverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u64> for JsonInt

type Error = JsonIntOverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for JsonInt

impl Eq for JsonInt

impl StructuralPartialEq for JsonInt