Struct Email 

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

Available on crate feature net only.

An email address.

This type provides type-safe email addresses with RFC 5322 validation. It uses the newtype pattern with #[repr(transparent)] for zero-cost abstraction.

Invariants

• Total length is 1-254 characters
• Local part is 1-64 characters
• Domain part follows RFC 1035 domain name rules
• Contains exactly one @ symbol
• Domain part is stored in lowercase for case-insensitive comparison
• Local part is case-sensitive (preserved as-is)

Examples

use bare_types::net::Email;

// Create an email
let email = Email::new("user@example.com")?;

// Access the string representation
assert_eq!(email.as_str(), "user@example.com");

// Get the local part
assert_eq!(email.local_part(), "user");

// Get the domain part
assert_eq!(email.domain_part(), "example.com");

// Parse from string
let email: Email = "user@example.com".parse()?;

Implementations

impl Email

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

Creates a new email address from a string.

Errors

Returns EmailError if the string does not comply with RFC 5322.

Examples

use bare_types::net::Email;

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

pub fn as_str(&self) -> &str

Returns the email address as a string slice.

Examples

use bare_types::net::Email;

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

pub const fn as_inner(&self) -> &String<254>

Returns a reference to the underlying heapless::String.

Examples

use bare_types::net::Email;

let email = Email::new("user@example.com").unwrap();
let inner: &heapless::String<254> = email.as_inner();
assert_eq!(inner.as_str(), "user@example.com");

pub fn into_inner(self) -> String<254>

Consumes this email and returns the underlying string.

Examples

use bare_types::net::Email;

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

pub fn local_part(&self) -> &str

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

Examples

use bare_types::net::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 address (after @).

Examples

use bare_types::net::Email;

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

Trait Implementations

impl<'a> Arbitrary<'a> for Email

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

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

Formats the value using the given formatter.

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<'_>) -> Result

Formats the value using the given formatter.

impl From<Email> for String<254>

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

fn cmp(&self, other: &Email) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

fn partial_cmp(&self, other: &Email) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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 TryFrom<&str> for Email

type Error = EmailError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Zeroize for Email

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for Email

impl StructuralPartialEq for Email