Enum Val

Source

pub enum Val {
    Null,
    Bool(bool),
    Int(isize),
    Float(f64),
    Num(Rc<String>),
    Str(Rc<String>),
    Arr(Rc<Vec<Val>>),
    Obj(Rc<IndexMap<Rc<String>, Val, RandomState>>),
}

Expand description

JSON value with sharing.

The speciality of this type is that numbers are distinguished into machine-sized integers and 64-bit floating-point numbers. This allows using integers to index arrays, while using floating-point numbers to do general math.

Operations on numbers follow a few principles:

The sum, difference, product, and remainder of two integers is integer.
Any other operation between two numbers yields a float.

Variants§

§

Null

§

Bool(bool)

Boolean

§

Int(isize)

Integer

§

Float(f64)

Floating-point number

§

Num(Rc<String>)

Floating-point number or integer not fitting into Int

§

Str(Rc<String>)

String

§

Arr(Rc<Vec<Val>>)

Array

§

Obj(Rc<IndexMap<Rc<String>, Val, RandomState>>)

Object

Implementations§

Source §

impl Val

Source

pub fn str(s: String) -> Self

Construct a string value.

Source

pub fn arr(v: Vec<Self>) -> Self

Construct an array value.

Source

pub fn obj(m: IndexMap<Rc<String>, Self, RandomState>) -> Self

Construct an object value.

Source

pub fn as_bool(&self) -> bool

True if the value is neither null nor false.

Source

pub fn as_int(&self) -> Result<isize, Error>

If the value is integer, return it, else fail.

Source

pub fn as_float(&self) -> Result<f64, Error>

If the value is or can be converted to float, return it, else fail.

Source

pub fn to_str(self) -> Result<Rc<String>, Error>

If the value is a string, return it, else fail.

Source

pub fn as_str(&self) -> Result<&Rc<String>, Error>

If the value is a string, return it, else fail.

Source

pub fn to_string_or_clone(&self) -> String

If the value is a Str, extract the inner string, else convert it to string.

Source

pub fn into_arr(self) -> Result<Rc<Vec<Self>>, Error>

If the value is an array, return it, else fail.

Source

pub fn as_arr(&self) -> Result<&Rc<Vec<Self>>, Error>

If the value is an array, return it, else fail.

Source

pub fn from_dec_str(n: &str) -> Self

Try to parse a string to a Self::Float, else return Self::Null.

Source

pub fn round(&self, f: impl FnOnce(f64) -> f64) -> Result<Self, Error>

Apply a rounding function to floating-point numbers, then convert them to integers.

Return integers unchanged, and fail on any other input.

Source

pub fn has(&self, key: &Self) -> Result<bool, Error>

Return true if value | .[key] is defined.

Fail on values that are neither arrays nor objects.

Source

pub fn keys_unsorted(&self) -> Result<Vec<Self>, Error>

Return any key for which value | .[key] is defined.

Fail on values that are neither arrays nor objects.

Source

pub fn try_into_iter(self) -> Result<Box<dyn Iterator<Item = Self>>, Error>

👎Deprecated since 1.3.0: use ValT::values instead

Return the elements of an array or the values of an object (omitting its keys).

Fail on any other value.

Source

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

a contains b iff either

the string b is a substring of a,
every element in the array b is contained in some element of the array a,
for every key-value pair k, v in b, there is a key-value pair k, v' in a such that v' contains v, or
a equals b.

Source

pub fn mutate_str(self, f: impl Fn(&mut String)) -> ValR

Apply a function to a string.

Source

pub fn mutate_arr(self, f: impl Fn(&mut Vec<Self>)) -> ValR

Apply a function to an array.

Source

pub fn try_mutate_arr( self, f: impl Fn(&mut Vec<Self>) -> Result<(), Error>, ) -> ValR

Apply a fallible function to an array.

Source

pub fn parse(token: Token, lexer: &mut impl LexAlloc) -> Result<Self, Error>

Parse at least one JSON value, given an initial token and a lexer.

If the underlying lexer reads input fallibly (for example IterLexer), the error returned by this function might be misleading. In that case, always check whether the lexer contains an error.