Enum Mechanism 

pub enum Mechanism {
    All,
    Include {
        macro_string: Macro,
    },
    A {
        macro_string: Macro,
        ip4_mask: u32,
        ip6_mask: u128,
    },
    Mx {
        macro_string: Macro,
        ip4_mask: u32,
        ip6_mask: u128,
    },
    Ptr {
        macro_string: Macro,
    },
    Ip4 {
        addr: Ipv4Addr,
        mask: u32,
    },
    Ip6 {
        addr: Ipv6Addr,
        mask: u128,
    },
    Exists {
        macro_string: Macro,
    },
}

An SPF mechanism (RFC 7208, Section 5).

mechanism        = ( all / include
                   / a / mx / ptr / ip4 / ip6 / exists )

Masks are stored as network bitmasks derived from the CIDR prefix length at parse time, not as prefix lengths: a /24 IPv4 prefix is stored as 0xFFFF_FF00, a missing prefix as all ones (host match) and /0 as zero (matches any address). An address matches when ip & mask == addr & mask.

Variants

All

all: always matches (Section 5.1).

Include

include:<domain-spec>: matches when the SPF record of the target domain evaluates to pass (Section 5.2).

Fields

macro_string: Macro

Target domain, as a macro string.

A

a[:<domain-spec>][/<ip4-cidr>][//<ip6-cidr>]: matches when the client IP is one of the target domain’s A or AAAA addresses (Section 5.3).

Fields

macro_string: Macro

Target domain, as a macro string; Macro::None means the current <domain>.

ip4_mask: u32

IPv4 network bitmask built from the ip4-cidr-length (default /32, all ones).

ip6_mask: u128

IPv6 network bitmask built from the ip6-cidr-length (default /128, all ones).

Mx

mx[:<domain-spec>][/<ip4-cidr>][//<ip6-cidr>]: matches when the client IP is an address of one of the target domain’s MX hosts (Section 5.4).

Fields

macro_string: Macro

Target domain, as a macro string; Macro::None means the current <domain>.

ip4_mask: u32

IPv4 network bitmask built from the ip4-cidr-length (default /32, all ones).

ip6_mask: u128

IPv6 network bitmask built from the ip6-cidr-length (default /128, all ones).

Ptr

ptr[:<domain-spec>]: matches when a validated reverse DNS name of the client IP ends in the target domain (Section 5.5; use is discouraged).

Fields

macro_string: Macro

Target domain, as a macro string; Macro::None means the current <domain>.

Ip4

ip4:<ip4-network>[/<ip4-cidr>]: matches when the client IP is in the given IPv4 network (Section 5.6).

Fields

addr: Ipv4Addr

Network address.

mask: u32

IPv4 network bitmask built from the CIDR prefix length (default /32, all ones).

Ip6

ip6:<ip6-network>[/<ip6-cidr>]: matches when the client IP is in the given IPv6 network (Section 5.6).

Fields

addr: Ipv6Addr

Network address.

mask: u128

IPv6 network bitmask built from the CIDR prefix length (default /128, all ones).

Exists

exists:<domain-spec>: matches when the target name has an A record (Section 5.7).

Fields

macro_string: Macro

Name to look up, as a macro string.

Implementations

impl Mechanism

pub fn needs_ptr(&self) -> bool

Returns true when the mechanism’s domain-spec uses the p macro, which requires a PTR lookup of the client IP before expansion.

Trait Implementations

impl Clone for Mechanism

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 Mechanism

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

Formats the value using the given formatter.

impl Eq for Mechanism

impl PartialEq for Mechanism

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Mechanism