Enum interface::Expression

pub enum Expression {
    Tag {
        tag: String,
    },
    KeyValue {
        key: String,
        value: String,
    },
    HasKey {
        key: String,
    },
    Parent {
        parent: String,
    },
    And {
        and: (Box<Expression, Global>, Box<Expression, Global>),
    },
    Or {
        or: (Box<Expression, Global>, Box<Expression, Global>),
    },
    Not {
        not: Box<Expression, Global>,
    },
    Empty,
}

A parsed (or manually constructed) query expression.

An expression can be arbitrarily nested.

Variants

Tag

Tag expression.

Evaluates to resolver items where the tag is present.

Fields of Tag

tag: String

KeyValue

Key/Value expression.

Evaluates to resolver items where the given key/value pair is present.

Fields of KeyValue

key: Stringvalue: String

HasKey

HasKey expression.

Evaluates to resolver items where the given key is present (in any key/value pair).

Fields of HasKey

key: String

Parent

Parent expression.

Evaluates to resolver items having the provided value as a parent.

Fields of Parent

parent: String

And

And expression.

Evaluates to the intersection of its two sub-expressions.

Fields of And

and: (Box<Expression, Global>, Box<Expression, Global>)

Or

Or expression. Evaluates to the union of its two sub-expressions.

Fields of Or

or: (Box<Expression, Global>, Box<Expression, Global>)

Not

Not expression. Evaluates to the negation of its sub-expression.

Fields of Not

not: Box<Expression, Global>

Empty

Empty expression. Evaluates to all items resolvable by the resolver.

Implementations

impl Expression

pub fn parse<S>(str_expr: S) -> Result<Expression, Error> where
    S: AsRef<str>, 

Parse an expression from a string.

Returns an error if the provided string could not be parsed.

Examples

use rapidquery::Expression;

let expression = "a && b";
match Expression::parse(expression) {
    Ok(expr) => println!("Got expression: {:?}", expr),
    Err(e) => panic!("failed to parse")
}

pub fn evaluate<R, V, E>(&self, resolver: &R) -> Result<V, E> where
    V: BitAndAssign<V> + BitOrAssign<V> + Not<Output = V> + Span + Display,
    R: Resolver<V, Error = E>, 

Evaluate an expression using a resolver.

The resolver is tasked with resolving the sets corresponding to the various sub-expressions kinds (tags, key/value pairs, etc.). From there, the evaluator will recursively compute the query, calling the resolver when appropriate.

Examples

use rapidquery::{Expression, Resolver};

let resolver: Box<dyn Resolver<bool, Error = std::io::Error>> = {
    unimplemented!()
};

let expr = Expression::Empty;;

let evaluation: bool = expr.evaluate(&resolver)?;

Trait Implementations

impl Clone for Expression

pub fn clone(&self) -> Expression

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Expression

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

Formats the value using the given formatter.

impl Default for Expression

pub fn default() -> Expression

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Expression

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<Expression, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Expression

impl From<ParsedExpr> for Expression

pub fn from(parsed: ParsedExpr) -> Expression

Performs the conversion.

impl From<Term> for Expression

pub fn from(t: Term) -> Expression

Performs the conversion.

impl Hash for Expression

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Expression> for Expression

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Expression

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Expression

impl StructuralPartialEq for Expression