Enum mail_chars::Charset

#[repr(u8)]
pub enum Charset {
    QTextWs,
    CTextWs,
    DTextWs,
    AText,
    RestrictedToken,
    Token,
    ObsNoWsCtl,
    Rfc7230Token,
}

An enum for the charsets represented through an internal lookup table.

Variants

QTextWs

qtext + ws, basically anything which can appear in a quoted string which is not a quoted-pair.

Note: this is equivalent to rfc7230 qdtext, excluding the obsolete part of the grammar. Note: the obsolete part of the grammar is excluded

rfc: 5322

CTextWs

ctext + ws

Note: the obsolete part of the grammar is excluded.

rfc: 5322

DTextWs

dtext + ws

rfc: 5322

AText

atext

rfc: 5322

RestrictedToken

Restricted-name-char subset of rfc2045 token with which IETF-tokens and IANA-tokens have to comply.

rfc: 6838 (related rfc2045)

Token

token

Note> there are multiple mail related definitions of token, this one is the rfc2045 based one.

rfc: 2045

ObsNoWsCtl

obs-NO-WS-CTL

rfc: 5322

combine with CText or QText to support the obsolete part of the grammar

Example

use mail_chars::{Charset, CharMatchExt, rfc5322};

fn is_ctext_with_obs(ch: char) -> bool {
    let res = Charset::lookup(ch);
    res.is(rfc5322::CTextWs) || res.is(rfc5322::ObsNoWsCtl)
}

assert!("\x01 comment \x02".chars().all(is_ctext_with_obs));

Rfc7230Token

token

rfc: 7230

Token as defined in rfc7230 (HTTP/1.1) not directly a mail grammar, but relevant for shared utilities like e.g. anything Media Type (i.e. MIME-Type/Content-Type) related.

Methods

impl Charset

pub fn contains(&self, ch: char) -> bool

Returns true if the char is part of this set of chars.

pub fn contains_or_non_ascii(&self, ch: char) -> bool

Returns true if the char is part of the set of chars or not an ascii char.

This is mainly meant to be used in combination with rfc6532 which extends all *text grammar parts/character sets to contain any non-us-ascii character.

pub fn lookup(ch: char) -> LookupResult

Uses the internal lookup table to classify a char.

Trait Implementations

impl Clone for Charset

fn clone(&self) -> Charset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Charset

impl Eq for Charset

impl Ord for Charset

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Charset> for Charset

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Charset> for Charset

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 Debug for Charset

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

Formats the value using the given formatter.

impl Hash for Charset

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].