Struct EmailAddress 

pub struct EmailAddress {
    pub value: String,
    pub email_type: Option<String>,
    pub primary: Option<bool>,
    pub display: Option<String>,
}

A validated SCIM email address.

EmailAddress represents an email address with optional metadata like type and primary flag. It enforces validation rules at construction time, ensuring that only valid email addresses can exist in the system.

Validation Rules

• Email value must not be empty
• Email value must be a valid string
• Email type, if provided, must not be empty
• Primary flag is optional
• Display name is optional

Examples

use scim_server::resource::value_objects::EmailAddress;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Valid email address
    let email = EmailAddress::new(
        "bjensen@example.com".to_string(),
        Some("work".to_string()),
        Some(true),
        Some("Barbara Jensen".to_string())
    )?;
    println!("Email: {}", email.value());

    // Simple email without metadata
    let simple_email = EmailAddress::new_simple("user@example.com".to_string())?;

    Ok(())
}

Fields

value: String

email_type: Option<String>

primary: Option<bool>

display: Option<String>

Implementations

impl EmailAddress

pub fn new( value: String, email_type: Option<String>, primary: Option<bool>, display: Option<String>, ) -> ValidationResult<Self>

Create a new EmailAddress with full metadata.

This is the primary constructor that enforces all validation rules. Use this method when creating EmailAddress instances from untrusted input.

Arguments

• value - The email address string to validate
• email_type - Optional type designation (e.g., “work”, “home”)
• primary - Optional flag indicating if this is the primary email
• display - Optional display name for the email

Returns

• Ok(EmailAddress) - If all values are valid
• Err(ValidationError) - If any value violates validation rules

pub fn new_simple(value: String) -> ValidationResult<Self>

Create a simple EmailAddress with just the email value.

Convenience constructor for creating email addresses without metadata.

Arguments

• value - The email address string to validate

Returns

• Ok(EmailAddress) - If the value is valid
• Err(ValidationError) - If the value violates validation rules

pub fn value(&self) -> &str

Get the email address value.

pub fn email_type(&self) -> Option<&str>

Get the email type.

pub fn primary(&self) -> Option<bool>

Get the primary flag.

pub fn display(&self) -> Option<&str>

Get the display name.

pub fn is_primary(&self) -> bool

Check if this is marked as the primary email.

Trait Implementations

impl Clone for EmailAddress

fn clone(&self) -> EmailAddress

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

Feeds a slice of this type into the given Hasher.

impl PartialEq for EmailAddress

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

fn from_schema_and_value( definition: &AttributeDefinition, value: &Value, ) -> ValidationResult<Self>

Create a value object from a JSON value and schema definition

fn can_construct_from(definition: &AttributeDefinition) -> bool

Check if this type can handle the given attribute definition

fn constructor_priority() -> u8

Get the priority for this constructor (higher = preferred) Used when multiple constructors might handle the same definition

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

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> ValidationResult<Self>

Performs the conversion.

impl TryFrom<String> for EmailAddress

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(value: String) -> ValidationResult<Self>

Performs the conversion.

impl ValueObject for EmailAddress

fn attribute_type(&self) -> AttributeType

Get the SCIM attribute type this value object represents

fn attribute_name(&self) -> &str

Get the schema attribute name this value object corresponds to

fn to_json(&self) -> ValidationResult<Value>

Serialize the value object to JSON

fn validate_against_schema( &self, definition: &AttributeDefinition, ) -> ValidationResult<()>

Validate the value object against a schema definition

fn as_json_value(&self) -> Value

Get the raw value as a JSON Value for schema-agnostic operations

fn supports_definition(&self, definition: &AttributeDefinition) -> bool

Check if this value object supports the given attribute definition

fn clone_boxed(&self) -> Box<dyn ValueObject>

Clone the value object as a boxed trait object

fn as_any(&self) -> &dyn Any

Get type information for downcasting

impl Eq for EmailAddress

impl StructuralPartialEq for EmailAddress