Struct Query

pub struct Query { /* private fields */ }

For querying Entries.

A Query contains a single validator and a key, which may be used for querying a set of Entries. Entries that pass the validator can be returned as the query results.

Queries are not meant to be used without associated context; they should be provided alongside information about what Document they are being used to query.

Implementations

impl Query

pub fn validator(&self) -> &Validator

Get the validator of this query.

pub fn key(&self) -> &str

Get the key of the entries this query will be made against.

pub fn query(&self, entry: &Entry) -> Result<DataChecklist<'_, ()>>

Execute the query against a given entry and see if it potentially matches.

The DataChecklist must be completed in order to fully determine if the entry matches. If the checklist completes successfully, the entry is a match for the query.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.