Enum jaq_interpret::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

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>

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.

Trait Implementations§

source§

impl Add for Val

§

type Output = Result<Val, Error>

The resulting type after applying the + operator.
source§

fn add(self, rhs: Self) -> Self::Output

Performs the + operation. Read more
source§

impl Clone for Val

source§

fn clone(&self) -> Val

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Val

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Val

source§

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

Formats the value using the given formatter. Read more
source§

impl Div for Val

§

type Output = Result<Val, Error>

The resulting type after applying the / operator.
source§

fn div(self, rhs: Self) -> Self::Output

Performs the / operation. Read more
source§

impl From<Val> for Value

source§

fn from(v: Val) -> Self

Converts to this type from the input type.
source§

impl From<Value> for Val

source§

fn from(v: Value) -> Self

Converts to this type from the input type.
source§

impl Mul for Val

§

type Output = Result<Val, Error>

The resulting type after applying the * operator.
source§

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation. Read more
source§

impl Neg for Val

§

type Output = Result<Val, Error>

The resulting type after applying the - operator.
source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
source§

impl Ord for Val

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Val

source§

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

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

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.
source§

impl PartialOrd for Val

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Rem for Val

§

type Output = Result<Val, Error>

The resulting type after applying the % operator.
source§

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation. Read more
source§

impl Sub for Val

§

type Output = Result<Val, Error>

The resulting type after applying the - operator.
source§

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation. Read more
source§

impl Eq for Val

Auto Trait Implementations§

§

impl RefUnwindSafe for Val

§

impl !Send for Val

§

impl !Sync for Val

§

impl Unpin for Val

§

impl UnwindSafe for Val

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Comparable<K> for Qwhere Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.