Struct Email 

pub struct Email(/* private fields */);

A validated email address

This type wraps the email_address crate to provide RFC-compliant email validation. It can be used in domain entities where email addresses are required.

Validation

The email address must conform to RFC 5321/5322 standards:

• Must have a local part and domain separated by @
• Local part can contain alphanumeric characters and some special characters
• Domain must be a valid domain name or IP address

Examples

use torrust_tracker_deployer_types::Email;

let email = Email::new("user@example.com").unwrap();
println!("Email: {}", email);

Implementations

impl Email

pub fn new(email: &str) -> Result<Email, EmailError>

Creates a new validated email address

Arguments

• email - The email address string to validate

Returns

• Ok(Email) - If the email is valid
• Err(EmailError) - If the email is invalid

Errors

Returns EmailError::InvalidFormat if the email doesn’t comply with RFC 5321/5322 standards.

Examples

use torrust_tracker_deployer_types::Email;

let valid = Email::new("admin@example.com");
assert!(valid.is_ok());

let invalid = Email::new("not-an-email");
assert!(invalid.is_err());

pub fn as_str(&self) -> &str

Returns the email address as a string slice

pub fn local_part(&self) -> &str

Returns the local part of the email (before the @)

Examples

use torrust_tracker_deployer_types::Email;

let email = Email::new("user@example.com").unwrap();
assert_eq!(email.local_part(), "user");

pub fn domain_part(&self) -> &str

Returns the domain part of the email (after the @)

Examples

use torrust_tracker_deployer_types::Email;

let email = Email::new("user@example.com").unwrap();
assert_eq!(email.domain_part(), "example.com");

Trait Implementations

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 duplicate 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<(), Error>

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Email

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

Formats the value using the given formatter.

impl From<Email> for String

fn from(email: Email) -> String

Converts to this type from the input type.

impl Hash for Email

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 JsonSchema for Email

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for Email

type Error = EmailError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Email, <Email as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for Email

impl StructuralPartialEq for Email