Struct serde_email::Email

pub struct Email { /* private fields */ }

A validated Email object.

These can be created from a string using Email::from_string, Email::from_str, or String::parse.

Once built you can turn this like a String, use with Serde, or Sea Orm.

Note that Email objects are case sensetive. The email addresses Email::from_str("bob@example.com") and Email::from_str("BoB@example.com"), will not be equal to each other.

Implementations

impl Email

pub fn from_string(raw_email: String) -> Result<Self, EmailError>

Creates a new Email, from the String given.

If the given string doesn’t look like a valid email, then this will return an EmailError.

pub fn from_str<S>(raw_email: S) -> Result<Self, EmailError>

where S: AsRef<str>,

Creates a new Email, from the str given.

If the given string doesn’t look like a valid email, then this will return an EmailError.

pub fn to_lowercase(&self) -> Self

Returns a new Email, where the email has been uppercased.

pub fn to_uppercase(&self) -> Self

Returns a new Email, where the internal email has been uppercased.

pub fn as_str<'a>(&'a self) -> &'a str

Trait Implementations

impl AsRef<String> for Email

fn as_ref(&self) -> &String

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for Email

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Email

fn clone(&self) -> Email

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Email

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

Formats the value using the given formatter.

impl Default for Email

This is a common default, provided in use for stuff like tests.

The default email is default@example.com.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Email

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Email

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

Formats the value using the given formatter.

impl From<Email> for String

fn from(email: Email) -> Self

Converts to this type from the input type.

impl FromStr for Email

type Err = EmailError

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 Email

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<&'a str> for Email

fn eq(&self, other: &&'a str) -> 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 PartialEq<String> for Email

fn eq(&self, other: &String) -> 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 PartialEq for Email

fn eq(&self, other: &Email) -> 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 Serialize for Email

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a str> for Email

type Error = EmailError

The type returned in the event of a conversion error.

fn try_from(raw: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Email

type Error = EmailError

The type returned in the event of a conversion error.

fn try_from(raw: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Email

impl StructuralPartialEq for Email