Enum jaq_core::Val

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>>),
}

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

impl Val

pub fn str(s: String) -> Self

Construct a string value.

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

Construct an array value.

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

Construct an object value.

pub fn as_bool(&self) -> bool

True if the value is neither null nor false.

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

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

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

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

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

Return 0 for null, the absolute value for numbers, and the length for strings, arrays, and objects.

Fail on booleans.

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.

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

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

Fail on values that are neither null, arrays, nor objects.

pub fn keys(&self) -> Result<Vec<Val>, Error>

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

Fail on values that are neither arrays nor objects.

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

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

Fail on any other value.

pub fn walk<'a>( self, f: &impl Fn(Val) -> Box<dyn Iterator<Item = ValR> + 'a> ) -> Box<dyn Iterator<Item = ValR> + 'a>

Recursively apply a function to each value.

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`.

pub fn from_json(&self) -> ValR

Convert string to a single JSON value.

Fail on any other value.

pub fn explode(&self) -> Result<Vec<Val>, Error>

Convert a string into an array of its Unicode codepoints.

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

Convert an array of Unicode codepoints into a string.

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

Apply a function to a string.

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

Apply a function to an array.

pub fn sort_by<'a>( self, f: impl Fn(Val) -> Box<dyn Iterator<Item = ValR> + 'a> ) -> ValR

Sort array by the given function.

Fail on any other value.

pub fn split(&self, sep: &Self) -> Result<Vec<Val>, Error>

Split a string by a given separator string.

Fail if any of the two given values is not a string.

pub fn regex( &self, re: &Self, flags: &Self, sm: (bool, bool) ) -> Result<Vec<Val>, Error>

Apply a regular expression to the given input value.

sm indicates whether to

1. output strings that do not match the regex, and
2. output the matches.

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

impl Add<Val> for Val

type Output = Result<Val, Error>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Val

fn clone(&self) -> Val

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Val

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

Formats the value using the given formatter.

impl Display for Val

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

Formats the value using the given formatter.

impl Div<Val> for Val

type Output = Result<Val, Error>

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<Val> for Value

fn from(v: Val) -> Value

Converts to this type from the input type.

impl From<Value> for Val

fn from(v: Value) -> Self

Converts to this type from the input type.

impl Mul<Val> for Val

type Output = Result<Val, Error>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Val

type Output = Result<Val, Error>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Val

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Val> for Val

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<Val> for Val

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 Rem<Val> for Val

type Output = Result<Val, Error>

The resulting type after applying the % operator.

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

Performs the % operation.

impl Sub<Val> for Val

type Output = Result<Val, Error>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Eq for Val