Struct Variables 

pub struct Variables<'x> { /* private fields */ }

The values substituted for each Variable during macro expansion (RFC 7208, Section 7).

MessageAuthenticator::check_host fills it from its SpfParameters; it can also be built with Variables::new and the set_* methods to expand a Macro with Macro::eval.

Implementations

impl<'x> Variables<'x>

pub fn new() -> Self

Creates an empty set of variables. The t macro (Variable::CurrentTime) expands to the current time unless it is set explicitly.

pub fn set_ip(&mut self, value: &IpAddr)

Sets the i, v and c macros from the client IP address.

pub fn set_sender(&mut self, value: impl Into<Cow<'x, [u8]>>)

Sets the s macro and, when the value contains @, the l (local part) and o (domain) macros.

pub fn set_helo_domain(&mut self, value: impl Into<Cow<'x, [u8]>>)

Sets the h macro (HELO or EHLO domain).

pub fn set_host_domain(&mut self, value: impl Into<Cow<'x, [u8]>>)

Sets the r macro (domain name of the host performing the check).

pub fn set_validated_domain(&mut self, value: impl Into<Cow<'x, [u8]>>)

Sets the p macro (validated domain name of the client IP).

pub fn set_domain(&mut self, value: impl Into<Cow<'x, [u8]>>)

Sets the d macro (the domain being evaluated).

pub fn get( &self, name: Variable, num_parts: u32, reverse: bool, escape: bool, fqdn: bool, delimiters: u64, ) -> Cow<'_, [u8]>

Returns the value of the variable name after applying the macro transformers (RFC 7208, Section 7.3).

The value is split on the characters in the delimiters bitmask (bit n stands for the byte b'+' + n), reversed when reverse is set, truncated to the num_parts right-hand parts (0 keeps all), joined with . and URL-encoded when escape is set. When fqdn is true and at least one transformer applies, a trailing . is added; a value without transformers is returned verbatim.

Trait Implementations

impl<'x> Clone for Variables<'x>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'x> Debug for Variables<'x>

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

Formats the value using the given formatter.

impl<'x> Default for Variables<'x>

fn default() -> Self

Returns the “default value” for a type.

impl<'x> Eq for Variables<'x>

impl<'x> PartialEq for Variables<'x>

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

Equality operator ==.

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

Inequality operator !=.

impl<'x> StructuralPartialEq for Variables<'x>