Skip to main content

HeaderForm

Enum HeaderForm 

Source
#[non_exhaustive]
pub enum HeaderForm { Raw, Text, Addresses, GroupedAddresses, MessageIds, Date, URLs, }
Expand description

Selector for the RFC 8621 parsed-form of a header value.

This is the form-token from a JMAP header:<name>:as<form> property selector, normalised to an enum.

Display emits the canonical JMAP form-token string (asRaw, asAddresses, …, asURLs). FromStr accepts exactly that set of strings; any other input yields UnknownHeaderForm.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Raw

Trim surrounding whitespace; return the bytes as a UTF-8 string. (§4.1.2.1)

Non-UTF-8 bytes — legal in raw RFC 5322 but not in JMAP wire format — are replaced with U+FFFD REPLACEMENT CHARACTER (lossy conversion). This preserves the position and rough shape of malformed input so callers can flag a mojibake header without losing the rest of the field body.

§

Text

RFC 8621 §4.1.2.2 Text form. Unfold whitespace, strip the trailing CRLF and leading SP, decode all syntactically-correct RFC 2047 encoded-words, then Unicode-normalise the result to NFC.

This is the form most commonly used by JMAP clients fetching human-readable header fields like Subject, Comments, Keywords, and List-Id.

§

Addresses

Parse as an RFC 5322 address-list. Group structure is discarded; only the flat list of mailboxes is returned. (§4.1.2.3)

§

GroupedAddresses

Parse as an RFC 5322 address-list, preserving group structure. (§4.1.2.4)

§

MessageIds

Parse as a list of RFC 5322 msg-id values. Surrounding angle brackets and CFWS are stripped. (§4.1.2.5)

§

Date

Parse as an RFC 5322 §3.3 date-time. (§4.1.2.6)

§

URLs

Parse as an RFC 2369 list of URLs. Surrounding angle brackets and comments are stripped. (§4.1.2.7)

Implementations§

Source§

impl HeaderForm

Source

pub fn as_jmap_token(&self) -> &'static str

Return the canonical RFC 8621 §4.1.2 form-token string for this variant.

The token starts with as (the convention used in JMAP property selectors such as header:Subject:asText). Inverse of HeaderForm’s FromStr impl.

Trait Implementations§

Source§

impl Clone for HeaderForm

Source§

fn clone(&self) -> HeaderForm

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HeaderForm

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for HeaderForm

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for HeaderForm

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for HeaderForm

Source§

impl FromStr for HeaderForm

Source§

type Err = UnknownHeaderForm

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl Hash for HeaderForm

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for HeaderForm

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for HeaderForm

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for HeaderForm

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.