io-email 0.1.0

Email client library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

//! # Search emails query
//!
//! This module exposes [`SearchEmailsQuery`], the top-level structure
//! that wraps a [`SearchEmailsFilterQuery`] (filter) and a
//! [`SearchEmailsSortQuery`] (sort).
//!
//! The query can be parsed from a string slice via [`FromStr`]; see
//! [`super::parser`] for the parser entry point and the grammar.

use core::str::FromStr;

use crate::search::{
    error::Error, filter::query::SearchEmailsFilterQuery, parser,
    sort::query::SearchEmailsSortQuery,
};

/// The search emails query structure.
///
/// Composed of an optional recursive [`SearchEmailsFilterQuery`] and an
/// optional [`SearchEmailsSortQuery`]. At least one of the two must be
/// present in a valid query string.
#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
pub struct SearchEmailsQuery {
    /// The recursive emails search filter query.
    pub filter: Option<SearchEmailsFilterQuery>,

    /// The emails search sort query.
    pub sort: Option<SearchEmailsSortQuery>,
}

impl FromStr for SearchEmailsQuery {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        parser::parse(s)
    }
}

#[cfg(test)]
mod tests {
    use alloc::{boxed::Box, vec};

    use crate::search::{
        filter::query::SearchEmailsFilterQuery,
        query::SearchEmailsQuery,
        sort::query::{SearchEmailsSorterKind::*, SearchEmailsSorterOrder::*},
    };

    #[test]
    fn filters_only() {
        assert_eq!(
            "from f and to t".parse::<SearchEmailsQuery>().unwrap(),
            SearchEmailsQuery {
                filter: Some(SearchEmailsFilterQuery::And(
                    Box::new(SearchEmailsFilterQuery::From("f".into())),
                    Box::new(SearchEmailsFilterQuery::To("t".into())),
                )),
                sort: None,
            },
        );
    }

    #[test]
    fn sorters_only() {
        assert_eq!(
            "order by from".parse::<SearchEmailsQuery>().unwrap(),
            SearchEmailsQuery {
                filter: None,
                sort: Some(vec![From.into()]),
            },
        );

        assert_eq!(
            "order by from asc subject desc"
                .parse::<SearchEmailsQuery>()
                .unwrap(),
            SearchEmailsQuery {
                filter: None,
                sort: Some(vec![From.into(), (Subject, Descending).into()]),
            },
        );
    }

    #[test]
    fn full() {
        assert_eq!(
            "from f and to t order by from to desc"
                .parse::<SearchEmailsQuery>()
                .unwrap(),
            SearchEmailsQuery {
                filter: Some(SearchEmailsFilterQuery::And(
                    Box::new(SearchEmailsFilterQuery::From("f".into())),
                    Box::new(SearchEmailsFilterQuery::To("t".into())),
                )),
                sort: Some(vec![From.into(), (To, Descending).into()]),
            },
        );
    }
}