Struct Flag 

pub struct Flag { /* private fields */ }

A flag attached to an envelope or message.

Constructed via Flag::from_raw (wire spelling in, IANA lookup derived) or Flag::from_iana (IANA tag in, canonical wire spelling synthesised). The constructor is named from_iana rather than iana to leave Flag::iana free as the accessor that returns the optional classification.

Implementations

impl Flag

pub fn from_raw(raw: impl Into<String>) -> Self

Builds a Flag from a wire spelling. The raw string is kept verbatim; the IANA classification is derived by classify_iana.

pub fn from_iana(iana: IanaFlag) -> Self

Builds a Flag tagged with an IanaFlag and the matching canonical wire spelling (\Seen, $Forwarded, …). Used by adapters whose wire format does not carry casing (Maildir letters) or when synthesising flags client-side.

pub fn raw(&self) -> &str

Original wire spelling as observed on the backend (or the canonical spelling when built from an IanaFlag).

pub fn iana(&self) -> Option<IanaFlag>

IANA classification when the raw spelling matched a registered keyword; None for user-defined custom keywords.

pub fn is_seen(&self) -> bool

pub fn is_answered(&self) -> bool

pub fn is_flagged(&self) -> bool

pub fn is_draft(&self) -> bool

pub fn is_deleted(&self) -> bool

pub fn is_forwarded(&self) -> bool

pub fn is_junk(&self) -> bool

pub fn is_notjunk(&self) -> bool

pub fn is_phishing(&self) -> bool

pub fn is_important(&self) -> bool

pub fn is_mdnsent(&self) -> bool

Trait Implementations

impl Clone for Flag

fn clone(&self) -> Flag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flag

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Flag

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Flag

impl Hash for Flag

fn hash<H: Hasher>(&self, state: &mut H)

Hashes the IANA tag first; falls back to the lowercase raw bytes when none, so that values comparing equal hash equal.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Flag

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

IANA-tagged flags sort before custom keywords (IANA-first canonical ordering). Within each group, IANA flags use the derived enum order and custom keywords compare on their lowercase raw text so that "Foo" and "foo" order consistently with equality.

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,

Restrict a value to a certain interval.

impl PartialEq for Flag

fn eq(&self, other: &Self) -> 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 PartialOrd for Flag

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Flag

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

where __S: Serializer,

Serialize this value into the given Serde serializer.