Struct email_address::EmailAddress

pub struct EmailAddress(_);

Type representing a single email address. This is basically a wrapper around a String, the email address is parsed for correctness with FromStr::from_str, which is the only want to create an instance. The various components of the email are not parsed out to be accessible independently.

Methods

impl EmailAddress

pub fn is_valid(address: &str) -> bool

Determine whether the address string is a valid email address. Note this is equivalent to the following:

use email_address::*;
use std::str::FromStr;

let is_valid = EmailAddress::from_str("johnstonskj@gmail.com").is_ok();

pub fn is_valid_local_part(part: &str) -> bool

Determine whether the part string would be a valid local-part if it were in an email address.

pub fn is_valid_domain(part: &str) -> bool

Determine whether the part string would be a valid domain if it were in an email address.

pub fn to_uri(&self) -> String

Return this email address formatted as a URI. This will also URI-encode the email address itself. So, name@example.org becomes mailto:name%40example.org.

pub fn to_display(&self, display_name: &str) -> String

Return a string formatted as a display email with the user name. This is commonly used in email headers and other locations where a display name is associated with the address.

So, ("name@example.org", "My Name") becomes "My Name <name@example.org>".

Trait Implementations

impl Clone for EmailAddress

fn clone(&self) -> EmailAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmailAddress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmailAddress

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for EmailAddress

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

Formats the value using the given formatter.

impl Eq for EmailAddress

impl FromStr for EmailAddress

type Err = Error

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 Hash for EmailAddress

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].

impl PartialEq<EmailAddress> for EmailAddress

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

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

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

This method tests for !=.

impl Serialize for EmailAddress

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

Serialize this value into the given Serde serializer.

impl StructuralEq for EmailAddress

impl StructuralPartialEq for EmailAddress