Struct aragog::query::Filter

pub struct Filter { /* fields omitted */ }

Allows to filter a query according to different Comparison. as an AQL string with the to_aql method.

Implementations

impl Filter

pub fn new(comparison: Comparison) -> Self

Instantiates a new query filter from a comparison item

Example

let filter = Filter::new(Comparison::field("age").greater_than(10));

pub fn and(self, comparison: Comparison) -> Self

Appends the filter current condition(s) with a new one with a AND logic.

Example

let mut filter = Filter::new(Comparison::field("age").greater_than(10));
filter = filter.and(Comparison::field("username").in_str_array(&["felix", "felixm"]));

pub fn or(self, comparison: Comparison) -> Self

Appends the filter current condition(s) with a new one with a OR logic.

Example

let mut filter = Filter::new(Comparison::field("age").greater_than(10));
filter = filter.or(Comparison::field("username").in_str_array(&["felix", "felixm"]));

pub fn to_aql(&self, collection_id: &str) -> String

Renders the AQL string corresponding to the current Filter. The query will go out of scope.

Example

let mut filter = Filter::new(Comparison::field("age").greater_than(10)).
    or(Comparison::field("username").in_str_array(&["felix", "felixm"]));
assert_eq!(filter.to_aql("i"), String::from(r#"i.age > 10 || i.username IN ["felix", "felixm"]"#));

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl From<Comparison> for Filter

fn from(comparison: Comparison) -> Self

Performs the conversion.