Struct EmailComparator 

#[non_exhaustive]
pub struct EmailComparator {
    pub property: ComparatorProperty,
    pub is_ascending: bool,
    pub collation: Option<String>,
    pub keyword: Option<Keyword>,
}

Sort comparator for Email/query (RFC 8621 §4.4.2).

When property is one of the keyword-based variants (ComparatorProperty::HasKeyword, ComparatorProperty::AllInThreadHaveKeyword, ComparatorProperty::SomeInThreadHaveKeyword), the keyword field MUST also be set. is_ascending defaults to true per RFC 8620 §5.5.

Excluded from extras preservation

This type is out of scope for the workspace extras-preservation policy: it carries no flatten-extras extra field, and its ComparatorProperty field is a closed control enum that backends must dispatch on. See ComparatorProperty and EmailFilterCondition for the rationale and for the two recommended paths (draft-ietf-jmap-metadata, bd JMAP-06zp; or the pre-IETF sloppy-value escape).

Cross-reference: bd JMAP-lbdy “Decision: filter algebra excluded”.

Construction

Use EmailComparator::new to construct from outside this crate. The struct is #[non_exhaustive]; struct literal syntax is not available to external callers.

use jmap_mail_types::query::{EmailComparator, ComparatorProperty};

let mut cmp = EmailComparator::new(ComparatorProperty::ReceivedAt);
cmp.is_ascending = false;  // sort descending

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

property: ComparatorProperty

The property to sort by.

is_ascending: bool

If true, sort ascending; if false, sort descending. Defaults to true per RFC 8620 §5.5.

collation: Option<String>

Collation algorithm (e.g. "i;ascii-casemap").

keyword: Option<Keyword>

Required when property is one of the keyword-based variants (RFC 8621 §4.4.2).

Implementations

impl EmailComparator

pub fn new(property: ComparatorProperty) -> Self

Construct an EmailComparator for the given property.

is_ascending defaults to true (RFC 8620 §5.5 default). collation and keyword default to None.

Set fields directly after construction:

use jmap_mail_types::query::{EmailComparator, ComparatorProperty};
use jmap_mail_types::Keyword;

let mut cmp = EmailComparator::new(ComparatorProperty::HasKeyword);
cmp.keyword = Some(Keyword::from("$flagged"));
cmp.is_ascending = false;

Trait Implementations

impl Clone for EmailComparator

fn clone(&self) -> EmailComparator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmailComparator

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmailComparator

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EmailComparator

impl PartialEq for EmailComparator

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for EmailComparator

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EmailComparator