Skip to main content

Expr

Enum Expr 

Source
pub enum Expr {
Show 13 variants Path(Vec<Step>), Literal(Value), Neg(Box<Expr>), Binary(BinOp, Box<Expr>, Box<Expr>), Pipe(Box<Expr>, Box<Expr>), Alternative(Box<Expr>, Box<Expr>), Comma(Vec<Expr>), Call(String, Vec<Expr>), Collect(Option<Box<Expr>>), ObjectConstruct(Vec<(String, Expr)>), Assign(Box<Expr>, Box<Expr>), UpdateAssign(Box<Expr>, Box<Expr>), AddAssign(Box<Expr>, Box<Expr>),
}
Expand description

An expression node.

Variants§

§

Path(Vec<Step>)

A path from the current input; an empty step list is identity (.).

§

Literal(Value)

A literal scalar value.

§

Neg(Box<Expr>)

Arithmetic negation.

§

Binary(BinOp, Box<Expr>, Box<Expr>)

A binary operation.

§

Pipe(Box<Expr>, Box<Expr>)

left | right - pipe each output of left into right.

§

Alternative(Box<Expr>, Box<Expr>)

left // right - jq’s alternative: left’s truthy outputs, or - when there are none (a miss, null, false) - right’s.

§

Comma(Vec<Expr>)

a, b, c - concatenate output streams.

§

Call(String, Vec<Expr>)

A function call, e.g. length, select(.x == 1), ltrimstr("pre").

§

Collect(Option<Box<Expr>>)

[ expr ] - collect the inner stream into an array (None = []).

§

ObjectConstruct(Vec<(String, Expr)>)

{ key: expr, ... } - construct an object.

§

Assign(Box<Expr>, Box<Expr>)

path = rhs - assign; rhs is evaluated against the whole input.

§

UpdateAssign(Box<Expr>, Box<Expr>)

path |= rhs - update-assign; rhs sees the current value at path.

§

AddAssign(Box<Expr>, Box<Expr>)

path += rhs - add-assign; path = path + rhs (numeric add, string/array concat). rhs is evaluated against the whole input.

Implementations§

Source§

impl Expr

Source

pub fn is_mutation(&self) -> bool

Does this expression mutate the document (contains an assignment or a del(...))? The CLI uses this to pick mutation mode vs query mode.

Source

pub fn as_path(&self) -> Option<&[Step]>

The path steps if this expression is a plain path (the only valid left side of an assignment), else None.

Source

pub fn has_comment(&self) -> bool

Does this expression address a comment (a # step) anywhere? The CLI routes such queries through the comment-aware evaluator and rejects comment mutation (a Phase-2 feature).

Trait Implementations§

Source§

impl Clone for Expr

Source§

fn clone(&self) -> Expr

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Expr

Source§

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

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

impl PartialEq for Expr

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Expr

Auto Trait Implementations§

§

impl Freeze for Expr

§

impl RefUnwindSafe for Expr

§

impl Send for Expr

§

impl Sync for Expr

§

impl Unpin for Expr

§

impl UnsafeUnpin for Expr

§

impl UnwindSafe for Expr

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where 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 T
where T: Clone,

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.