Enum Macro 

pub enum Macro {
    Literal(Box<[u8]>),
    Variable {
        letter: Variable,
        num_parts: u32,
        reverse: bool,
        escape: bool,
        delimiters: u64,
    },
    List(Box<[Macro]>),
    None,
}

A parsed SPF macro string (RFC 7208, Section 7.1).

Appears as the domain-spec of mechanisms, in the redirect= and exp= modifiers, and as the explanation text fetched from the exp= target.

Variants

Literal(Box<[u8]>)

Literal text, copied verbatim.

Variable

A %{...} macro expansion.

Fields

letter: Variable

The macro letter.

num_parts: u32

Number of right-hand parts to keep after splitting; 0 keeps all.

reverse: bool

Reverse the order of the parts (r transformer).

escape: bool

URL-encode the result (uppercase macro letter).

delimiters: u64

Bitmask of delimiter characters: bit n set means the byte b'+' + n is a delimiter. Defaults to . only.

List(Box<[Macro]>)

A concatenation of literals and variables.

None

No macro string was given; Macro::eval returns the supplied default.

Implementations

impl Macro

pub fn eval<'z, 'x: 'z>( &'z self, vars: &'x Variables<'x>, default: &'x str, fqdn: bool, ) -> Cow<'z, str>

Expands the macro string using vars (RFC 7208, Section 7.3).

Returns default for Macro::None. When fqdn is true, a trailing . is appended to a list expansion, and to a variable expansion that applies a transformer, unless it already ends in one. Literals, and variables expanded verbatim, are returned unchanged. Invalid UTF-8 expands to an empty string.

pub fn needs_ptr(&self) -> bool

Returns true when the macro string references the p macro letter (Variable::ValidatedDomain).

Trait Implementations

impl Clone for Macro

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Macro

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

Formats the value using the given formatter.

impl Eq for Macro

impl From<Macro> for TxtRecord

fn from(v: Macro) -> Self

Converts to this type from the input type.

impl PartialEq for Macro

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Macro

impl TxtRecordParser for Macro

fn parse(record: &[u8]) -> Result<Self>

Parses the contents of one TXT record, with its character strings already concatenated.

fn parse_records(records: &[Vec<u8>]) -> Result<Self>

Parses the TXT records found at one name, each with its character strings already concatenated. The default implementation returns the first record that parse accepts, or the error of the last one.