Enum jaq_core::Val

pub enum Val {
    Null,
    Bool(bool),
    Pos(usize),
    Neg(usize),
    Float(f64),
    Num(Rc<Number>),
    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 positive integers, negative integers, and 64-bit floating-point numbers. All integers are machine-sized. 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.
• The quotient of two integers is integer if the remainder of the integers is zero.
• Any other operation between two numbers yields a float.

Variants

Null

Bool(bool)

Boolean

Pos(usize)

Positive integer

Neg(usize)

Negative integer

Float(f64)

Floating-point number

Num(Rc<Number>)

Floating-point number or integer not fitting neither into Pos nor Neg

Str(Rc<String>)

String

Arr(Rc<Vec<Val>>)

Array

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

Order-preserving map

Implementations

impl Val

pub fn as_bool(&self) -> bool

True if the value is neither null nor false.

pub fn as_usize(&self) -> Result<usize, Error>

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

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

If the value is integer, return its absolute value and whether its positive, else fail.

pub fn as_obj_key(&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 typ(&self) -> &str

Return the type of the value, e.g. “boolean” for true and false.

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 range(
    &self,
    other: &Self
) -> Result<Box<dyn Iterator<Item = Self>>, Error>

Return all numbers in the range [self, other) if both inputs are integer, else fail.

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<Box<dyn Iterator<Item = Val> + '_>, Error>

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

Fail on values that are neither arrays nor objects.

pub fn 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 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) -> Result<Val, Error>

Convert string to JSON.

Fail on any other value.

pub fn sort(self) -> Result<Val, Error>

Sort array by the default order.

Fail on any other value.

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

Sort array by the given function.

Fail on any other value.

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<(), Error>

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<&'_ Number> for Val

fn from(n: &Number) -> Self

Converts to this type from the input type.

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) -> Self

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> 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 !=.

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