Enum Criteria 

#[non_exhaustive]
pub enum Criteria {
    Value(Value),
    Property(Vec<String>),
    Parameter(String),
    Unary(UnaryOp, Box<Criteria>),
    Binary(BinaryOp, Box<Criteria>, Box<Criteria>),
    Group(GroupOp, Vec<Criteria>),
    In(Box<Criteria>, Vec<Criteria>),
    Between(Box<Criteria>, Box<Criteria>, Box<Criteria>),
    IsNull(Box<Criteria>),
    Function(Function, Vec<Criteria>),
    Custom(String, Vec<Criteria>),
    Aggregate(Box<AggregateCall>),
}

A parsed expression or filter.

use ravenrs_criteria::Criteria;

let c = Criteria::parse("[Price] * [Qty] > 100 And [Active]").expect("valid");
assert_eq!(c.to_string(), "[Price] * [Qty] > 100 And [Active]");
assert_eq!(c.properties(), ["Price", "Qty", "Active"]);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Value(Value)

A literal.

Property(Vec<String>)

A field path, such as Customer.Name; a leading ^ reads the parent row.

Parameter(String)

A parameter, ?Name.

Unary(UnaryOp, Box<Criteria>)

A unary operator.

Binary(BinaryOp, Box<Criteria>, Box<Criteria>)

A binary operator.

Group(GroupOp, Vec<Criteria>)

And or Or over two or more operands.

In(Box<Criteria>, Vec<Criteria>)

value In (a, b, c).

Between(Box<Criteria>, Box<Criteria>, Box<Criteria>)

value Between(low, high).

IsNull(Box<Criteria>)

value Is Null.

Function(Function, Vec<Criteria>)

A built-in function.

Custom(String, Vec<Criteria>)

A function resolved by name when evaluated (see crate::Environment::register).

Aggregate(Box<AggregateCall>)

An aggregate over the current scope, or over a nested collection.

Implementations

impl Criteria

pub fn parse(source: &str) -> Result<Self, ParseError>

Parses source; see the crate documentation for the syntax.

pub fn assignments(source: &str) -> Result<Vec<(String, Self)>, ParseError>

Parses assignments, field = expression; ..., as an update sets fields: each field with the expression that gives its new value.

use ravenrs_criteria::Criteria;

let set = Criteria::assignments("state = 'done'; [finished] = Today()").unwrap();
assert_eq!(set[0].0, "state");
assert_eq!(set[1].0, "finished");

pub fn property(path: &str) -> Self

A field.

pub fn value(value: impl Into<Value>) -> Self

A literal.

pub fn equals(self, other: Self) -> Self

self = other.

pub fn and(self, other: Self) -> Self

self And other, flattening nested Ands.

pub fn or(self, other: Self) -> Self

self Or other, flattening nested Ors.

pub fn walk(&self, f: &mut dyn FnMut(&Criteria))

Calls f on this node and everything under it.

pub fn properties(&self) -> Vec<String>

The field paths used, in order, without repeats.

pub fn parameters(&self) -> Vec<String>

The parameter names used, in order, without repeats.

pub fn any(&self, test: &dyn Fn(&Criteria) -> bool) -> bool

True when any node satisfies test.

Trait Implementations

impl Clone for Criteria

fn clone(&self) -> Criteria

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Criteria

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

Formats the value using the given formatter.

impl Display for Criteria

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

Formats the value using the given formatter.

impl Not for Criteria

fn not(self) -> Self

Not self.

type Output = Criteria

The resulting type after applying the ! operator.

impl PartialEq for Criteria

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Criteria