Struct Query 

pub struct Query<E: Queryable> { /* private fields */ }

The container and root for queries.

See the module documentation for a explanation.

Implementations

impl<E: Queryable> Query<E>

pub fn into_normal_representation(self) -> String

Turn this Query into it’s normal representations, that actually conforms to the EBNF given in the module documentation.

Note

This is just calling the Display implementation.

impl<E: Queryable> Query<E>

pub fn from_continuous_str( user_state: &<E::KeyValue as QueryKeyValue>::UserState, s: &str, parse_mode: ParseMode, ) -> Result<Query<E>, Error<E>>

where <E::KeyValue as QueryKeyValue>::Err: Debug + Display,

Construct this Query from a continuous string. This will correctly split the string according to shell splitting rules (i.e., it takes double and single quotes into account). This is useful, if you only don’t have a shell in between taking this string from your user. If your already have a split string, use Query::from_slice.

Errors

If the input does not parse as a Query.

pub fn from_slice<'a, T>( user_state: &<E::KeyValue as QueryKeyValue>::UserState, s: T, parse_mode: ParseMode, ) -> Result<Query<E>, Error<E>>

where T: Iterator<Item = &'a str>, <E::KeyValue as QueryKeyValue>::Err: Debug + Display,

Construct this Query from an already split up string. This will assume that similar parts are in one split (i.e., title:Nice AND status:open, should resolve to three distinct splits). Only use this function if your input is already split up by something like a UNIX shell. Otherwise, you can use Query::from_continuous_str to supply a (correctly quoted) string.

Errors

If the input does not parse as a Query.

pub fn matches(&self, object: &E) -> bool

Check whether this Query matches the Queryable object.

pub fn from_matcher(matcher: Matcher<E>) -> Self

Construct this Query from a Matcher.

This is useful, if you need to construct a query or want to compose multiple queries together (for example, after accessing matchers via Query::as_matcher).

pub fn as_matcher(&self) -> Option<&Matcher<E>>

Get access to the underlying Matcher of this Query.

pub fn into_matcher(self) -> Option<Matcher<E>>

Turn this Query into its underlying Matcher.

pub fn as_mut_matcher(&mut self) -> Option<&mut Matcher<E>>

Get access to the underlying mutable Matcher of this Query.

Trait Implementations

impl<E: Clone + Queryable> Clone for Query<E>

fn clone(&self) -> Query<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Queryable> Debug for Query<E>

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

Formats the value using the given formatter.

impl<E: Queryable> Display for Query<E>

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

Formats the value using the given formatter.