/email-type-rs

Email type for "Parse, don't validate" approach

Primary LanguageRust

Email type

Email type for approach suggested by Alexis King - "Parse, don't validate".

How to use:

Add dependency:

email-type-rs = { git = "https://github.com/lebe-dev/email-type-rs", version = "1.0.0", features = ["utils"] }

Use:

let email = Email::from_str("lexi.lambda@gmail.com")?;
let email = "lexi.lambda@gmail.com".parse()?;

// fn some_func(value: &str)
some_func(email.as_str());
some_func(&email);

Useful for REST API Endpoints, i.e. /api/register accepts:

#[derive(Deserialize)]
struct UserRegistrationRequest {
    pub email: Email,
    ...
}

Incoming JSON with invalid value in email field will raise deserialization error (Serde).

Util functions

Add to Cargo.toml:

[dev-dependencies]
email-type-rs = { git = "https://github.com/lebe-dev/email-type-rs", version = "1.0.0", features = ["utils"] }

Functions:

  • get_random_email() - return random Email. Useful for tests.

Thanks