Struct Spf 

pub struct Spf<T> { /* private fields */ }

Base struct for an Spf of any type.

Implementations

impl Spf<String>

pub fn new(s: &str) -> Result<Self, SpfError>

Creates a Spf<String> from the passed str reference. This is basically a rapper around FromStr which has been implemented for Spf<String>

pub fn is_v1(&self) -> bool

Check that version is v1

pub fn built(&self) -> bool

Check if the Spf record was created from crate::SpfBuilder<Builder> or from &str

let spf = "v=spf1 -all".parse::<Spf<String>>().unwrap();
assert!(!spf.built());

pub fn redirect(&self) -> Option<&Mechanism<String>>

Give access to the redirect modifier if present

pub fn all(&self) -> Option<&Mechanism<String>>

Give access to the all mechanism if it is present.

pub fn validate(&self) -> Result<(), SpfErrors>

Validation for Spf<String>

Examples

use decon_spf::{Spf, SpfError, SpfErrors};
let spf = "v=spf1 -all".parse::<Spf<String>>().unwrap();
assert!(spf.validate().is_ok());
let spf = "v=spf1 redirect=_spf.example.com -all".parse::<Spf<String>>().unwrap();
assert!(spf.validate().is_err());
let spf: SpfErrors = spf.validate().unwrap_err();
println!("{}", spf.source());
for e in spf.errors() {
    println!("{}",e);
}

Returns

Either Ok or a SpfErrors containing any SpfError

Errors:

• Hard Errors
  • Invalid version
  • Source Length Exceeded
• Soft Errors
  • Deprecated PTR detected
  • Lookup Count Exceeded
  • Redirect & All
  • Redirect Position

impl<T> Spf<T>

where T: Default + Debug + Display,

pub fn version(&self) -> &T

Access the version attribute associated with the Spf record.

pub fn lookup_count(&self) -> u8

Access the number of DNS lookups required for this Spf record.

pub fn iter(&self) -> SpfIterator<'_, T>

Iterate over the Spf Mechanisms of the Spf Record. This does not return the Spf version, but iterates over the mechanisms contained within the Spf record.

Trait Implementations

impl<T: Clone> Clone for Spf<T>

fn clone(&self) -> Spf<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Spf<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Spf<T>

fn default() -> Spf<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Spf<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Spf<String>

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

Formats the value using the given formatter.

impl From<Spf<String>> for SpfBuilder<Builder>

Available on crate feature builder only.

Converts a Spf<String> into a SpfBuilder`struct.

fn from(source: Spf<String>) -> SpfBuilder<Builder>

Converts to this type from the input type.

impl FromStr for Spf<String>

Implement parse for Spf<String>

Errors

• Invalid Version
• String length exceeds 512 octets (characters)

Soft Errors

These will be found when calling validate() on Spf<String>

type Err = SpfError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl<T> IntoIterator for Spf<T>

type Item = Mechanism<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<<Spf<T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for Spf<T>

fn eq(&self, other: &Spf<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for Spf<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Spf<String>

type Error = SpfError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> StructuralPartialEq for Spf<T>