Enum Val 

pub enum Val {
    Null,
    Bool(bool),
    Num(Num),
    BStr(Box<Bytes>),
    TStr(Box<Bytes>),
    Arr(Rc<Vec<Val>>),
    Obj(Rc<Map<Val, Val>>),
}

JSON superset with binary data and non-string object keys.

This is the default value type for jaq.

Variants

Null

Null

Bool(bool)

Boolean

Num(Num)

Number

BStr(Box<Bytes>)

Byte string

TStr(Box<Bytes>)

Text string (interpreted as UTF-8)

Note that this does not require the actual bytes to be all valid UTF-8; this just means that the bytes are interpreted as UTF-8. An effort is made to preserve invalid UTF-8 as is, else replace invalid UTF-8 by the Unicode replacement character.

Arr(Rc<Vec<Val>>)

Array

Obj(Rc<Map<Val, Val>>)

Object

Implementations

impl Val

pub fn try_as_bytes_owned(&self) -> Result<Bytes, Error>

Return bytes if the value is a (byte or text) string.

pub fn try_as_utf8_bytes_owned(&self) -> Result<Bytes, Error>

Return bytes if the value is a text string.

impl Val

pub fn obj(m: Map) -> Self

Construct an object value.

pub fn utf8_str(s: impl Into<Bytes>) -> Self

Construct a string that is interpreted as UTF-8.

pub fn byte_str(s: impl Into<Bytes>) -> Self

Construct a string that is interpreted as bytes.

Trait Implementations

impl Add for Val

type Output = Result<Val, Error<Val>>

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

fn default() -> Val

Returns the “default value” for a type.

impl Display for Val

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

Formats the value using the given formatter.

impl Div for Val

type Output = Result<Val, Error<Val>>

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<Range<Option<Val>>> for Val

fn from(r: Range<Val>) -> Self

Converts to this type from the input type.

impl From<String> for Val

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<bool> for Val

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Val

fn from(f: f64) -> Self

Converts to this type from the input type.

impl From<isize> for Val

fn from(i: isize) -> Self

Converts to this type from the input type.

impl From<usize> for Val

fn from(i: usize) -> Self

Converts to this type from the input type.

impl FromIterator<Val> for Val

fn from_iter<T: IntoIterator<Item = Self>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Val

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

type Output = Result<Val, Error<Val>>

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

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

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 Val

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

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

type Output = Result<Val, Error<Val>>

The resulting type after applying the % operator.

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

Performs the % operation.

impl Sub for Val

type Output = Result<Val, Error<Val>>

The resulting type after applying the - operator.

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

Performs the - operation.

impl ValT for Val

fn as_bool(&self) -> bool

True if the value is neither null nor false.

fn from_num(n: &str) -> ValR

Create a number from a string.

fn from_map<I: IntoIterator<Item = (Self, Self)>>(iter: I) -> ValR

Create an associative map (or object) from a sequence of key-value pairs.

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

Yield the key-value pairs of a value.

fn values(self) -> Box<dyn Iterator<Item = ValR>>

Yield the children of a value.

fn index(self, index: &Self) -> ValR

Yield the child of a value at the given index.

fn range(self, range: Range<&Self>) -> ValR

Yield a slice of the value with the given range.

fn map_values<'a, I: Iterator<Item = ValX<'a>>>( self, opt: Opt, f: impl Fn(Self) -> I, ) -> ValX<'a>

Map a function over the children of the value.

fn map_index<'a, I: Iterator<Item = ValX<'a>>>( self, index: &Self, opt: Opt, f: impl Fn(Self) -> I, ) -> ValX<'a>

Map a function over the child of the value at the given index.

fn map_range<'a, I: Iterator<Item = ValX<'a>>>( self, range: Range<&Self>, opt: Opt, f: impl Fn(Self) -> I, ) -> ValX<'a>

Map a function over the slice of the value with the given range.

fn into_string(self) -> Self

Convert value into a string value.

impl ValT for Val

fn into_seq<S: FromIterator<Self>>(self) -> Result<S, Self>

Convert an array into a sequence.

fn is_int(&self) -> bool

True if the value is integer.

fn as_isize(&self) -> Option<isize>

Use the value as machine-sized integer.

fn as_f64(&self) -> Option<f64>

Use the value as floating-point number.

fn is_utf8_str(&self) -> bool

True if the value is interpreted as UTF-8 string.

fn as_bytes(&self) -> Option<&[u8]>

If the value is a string (whatever its interpretation), return its bytes.

fn as_sub_str(&self, sub: &[u8]) -> Self

If the value is a string and sub points to a slice of the string, shorten the string to sub, else panic.

fn from_utf8_bytes(b: impl AsRef<[u8]> + Send + 'static) -> Self

Interpret bytes as UTF-8 string value.

fn as_utf8_bytes(&self) -> Option<&[u8]>

If the value is interpreted as UTF-8 string, return its bytes.

fn try_as_bytes(&self) -> Result<&[u8], Error<Self>>

If the value is a string (whatever its interpretation), return its bytes, else fail.

fn try_as_utf8_bytes(&self) -> Result<&[u8], Error<Self>>

If the value is interpreted as UTF-8 string, return its bytes, else fail.

impl Eq for Val