Enum jaq_syn::filter::Filter

pub enum Filter<C = String, V = String, Num = String> {
    Call(C, Vec<Spanned<Self>>),
    Var(V),
    Num(Num),
    Str(Box<Str<Spanned<Self>>>),
    Array(Option<Box<Spanned<Self>>>),
    Object(Vec<KeyVal<Spanned<Self>>>),
    Id,
    Path(Box<Spanned<Self>>, Path<Self>),
    Ite(Vec<(Spanned<Self>, Spanned<Self>)>, Option<Box<Spanned<Self>>>),
    Fold(FoldType, Fold<Box<Spanned<Self>>>),
    TryCatch(Box<Spanned<Self>>, Option<Box<Spanned<Self>>>),
    Try(Box<Spanned<Self>>),
    Neg(Box<Spanned<Self>>),
    Recurse,
    Binary(Box<Spanned<Self>>, BinaryOp, Box<Spanned<Self>>),
}

Function from value to stream of values, such as .[] | add / length.

Variants

Call(C, Vec<Spanned<Self>>)

Call to another filter, e.g. map(.+1)

Var(V)

Variable, such as $x (without leading ‘$’)

Num(Num)

Integer or floating-point number.

Str(Box<Str<Spanned<Self>>>)

String

Array(Option<Box<Spanned<Self>>>)

Array, empty if None

Object(Vec<KeyVal<Spanned<Self>>>)

Object, specifying its key-value pairs

Id

Identity, i.e. .

Path(Box<Spanned<Self>>, Path<Self>)

Path such as ., .a, .[][]."b"

Ite(Vec<(Spanned<Self>, Spanned<Self>)>, Option<Box<Spanned<Self>>>)

If-then-else

Fold(FoldType, Fold<Box<Spanned<Self>>>)

reduce and foreach, e.g. reduce .[] as $x (0; .+$x)

The first field indicates whether to yield intermediate results (false for reduce and true for foreach).

TryCatch(Box<Spanned<Self>>, Option<Box<Spanned<Self>>>)

try and optional catch

Try(Box<Spanned<Self>>)

Error suppression, e.g. keys?

Neg(Box<Spanned<Self>>)

Negation

Recurse

Recursion (..)

Binary(Box<Spanned<Self>>, BinaryOp, Box<Spanned<Self>>)

Binary operation, such as 0, 1, [] | .[], .[] += 1, 0 == 0, …

Implementations

impl Filter

pub fn binary(a: Spanned<Self>, op: BinaryOp, b: Spanned<Self>) -> Spanned<Self>

Create a binary expression, such as 1 + 2.

pub fn path(f: Spanned<Self>, path: Path<Self>, span: Span) -> Spanned<Self>

Create a path expression, such as keys[] or .a.b.

Here, f is a filter on whose output the path is executed on, such as keys and . in the example above.

Trait Implementations

impl<C: Clone, V: Clone, Num: Clone> Clone for Filter<C, V, Num>

fn clone(&self) -> Filter<C, V, Num>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, V: Debug, Num: Debug> Debug for Filter<C, V, Num>

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

Formats the value using the given formatter.

impl<'de, C, V, Num> Deserialize<'de> for Filter<C, V, Num>

where C: Deserialize<'de>, V: Deserialize<'de>, Num: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Call<(Filter, Range<usize>)>> for Filter

fn from(c: Call<Spanned<Filter>>) -> Self

Converts to this type from the input type.

impl From<Str<(Filter, Range<usize>)>> for Filter

fn from(s: Str<Spanned<Filter>>) -> Self

Converts to this type from the input type.

impl<C, V, Num> Serialize for Filter<C, V, Num>

where C: Serialize, V: Serialize, Num: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.