Struct email::search_query::SearchEmailsQuery

pub struct SearchEmailsQuery {
    pub filter: Option<SearchEmailsFilterQuery>,
    pub sort: Option<SearchEmailsSortQuery>,
}

The search emails query structure.

The query is composed of a recursive SearchEmailsFilterQuery and a list of [SearchEmailsSorter]s.

Fields

filter: Option<SearchEmailsFilterQuery>

The recursive emails search filter query.

sort: Option<SearchEmailsSortQuery>

The emails search sort query.

Implementations

impl SearchEmailsQuery

pub fn to_imap_sort_query(&self) -> String

pub fn to_imap_sort_criteria(&self) -> Vec<SortCriterion<'_>>

impl SearchEmailsQuery

pub fn matches_maildir_search_query( &self, envelope: &Envelope, msg_path: &Path ) -> bool

impl SearchEmailsQuery

pub fn to_notmuch_search_query(&self) -> String

Trait Implementations

impl Clone for SearchEmailsQuery

fn clone(&self) -> SearchEmailsQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchEmailsQuery

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

Formats the value using the given formatter.

impl FromStr for SearchEmailsQuery

Parse the given string slice into a SearchEmailsQuery.

Because of the recursive nature of SearchEmailsFilterQuery, it is not possible to directly parse a full query from a string using chumsky. Instead the string is splitted in two, and filters and sorters are parsed separately.

A search emails query string can contain a filter query, a sorter query or both. In this last case, the filter query needs to be defined first, then the sorter query. They should be separated by the keyword "order by".

See filter::parser::query for more details on the filter query string API, and sort::parser::query for more details on the sort query API.

Examples

use email::search_query::SearchEmailsQuery;
use std::str::FromStr;

pub fn main() {
    // filter only
    "subject foo and body bar".parse::<SearchEmailsQuery>().unwrap();

    // sort only
    "order by date desc".parse::<SearchEmailsQuery>().unwrap();

    // filter then sort
    "subject foo and body bar order by subject".parse::<SearchEmailsQuery>().unwrap();
}

ABNF

query = filter-query / "order by" SP sort-query / filter-query SP "order by" SP sort-query


filter-query = filter *(SP filter)


filter =  "(" filter ")"
               ; nested filter

filter =/ and / or / not
               ; filter operators

filter =/ date / before-date / after-date / from / to / subject / body / flag
               ; filter conditions


and = filter SP "and" SP filter

or  = filter SP "or" SP filter

not = "not" SP filter


date        = "date" SP date-pattern

before-date = "before" SP date-pattern

after-date  = "before" SP date-pattern

from        = "from" SP text-pattern

to          = "to" SP text-pattern

subject     = "subject" SP text-pattern

body        = "body" SP text-pattern

flag        = "flag" SP text-pattern


date-pattern =  4DIGIT "-" 2DIGIT "-" 2DIGIT
                     ; date matching "YYYY-MM-dd" format

date-pattern =/ 4DIGIT "/" 2DIGIT "/" 2DIGIT
                     ; date matching "YYYY/MM/dd" format

date-pattern =/ 2DIGIT "-" 2DIGIT "-" 4DIGIT
                     ; date matching "dd-MM-YYYY" format

date-pattern =/ 2DIGIT "/" 2DIGIT "/" 4DIGIT
                     ; date matching "dd/MM/YYYY" format


text-pattern = DQUOTE *VCHAR DQUOTE


sort-query   = sorter *(SP sorter)

sorter       = sorter-kind [SP sorter-order]

sorter-kind  = "date" / "from" / "to" / "subject"

sorter-order = "asc" / "desc"

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for SearchEmailsQuery

fn cmp(&self, other: &SearchEmailsQuery) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SearchEmailsQuery

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SearchEmailsQuery

fn partial_cmp(&self, other: &SearchEmailsQuery) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SearchEmailsQuery

impl StructuralPartialEq for SearchEmailsQuery