Struct HttpsConfig 

pub struct HttpsConfig { /* private fields */ }

Domain-level HTTPS configuration for TLS termination

Contains validated HTTPS settings used for Caddy reverse proxy configuration. This type is created from the application-layer DTO (HttpsSection) after validation and stored in the environment.

Let’s Encrypt Environments

• Production (default): Trusted certificates, rate-limited
• Staging: Untrusted test certificates, higher rate limits

Example

use torrust_tracker_deployer_lib::domain::https::HttpsConfig;

let config = HttpsConfig::new("admin@example.com", false).unwrap();
assert_eq!(config.admin_email(), "admin@example.com");
assert!(!config.use_staging());

Implementations

impl HttpsConfig

pub fn new( admin_email: impl Into<String>, use_staging: bool, ) -> Result<Self, HttpsConfigError>

Creates a new HTTPS configuration with validated email

Validates the admin email format at construction time, ensuring the configuration is always valid.

Arguments

• admin_email - Admin email for Let’s Encrypt notifications
• use_staging - Whether to use staging environment

Errors

Returns HttpsConfigError::InvalidEmail if the email format is invalid.

Examples

use torrust_tracker_deployer_lib::domain::https::HttpsConfig;

// Production configuration
let config = HttpsConfig::new("admin@example.com", false).unwrap();
assert!(!config.use_staging());

// Staging configuration (for testing)
let staging = HttpsConfig::new("admin@example.com", true).unwrap();
assert!(staging.use_staging());

// Invalid email is rejected
let result = HttpsConfig::new("invalid-email", false);
assert!(result.is_err());

pub fn from_validated_email(email: &Email, use_staging: bool) -> Self

Creates an HTTPS config from a validated email

This is the preferred factory method when working with validated email addresses from the application layer. Since the email is already validated, this method is infallible.

Arguments

• email - Validated email address
• use_staging - Whether to use staging environment

pub fn admin_email(&self) -> &str

Returns the admin email address

pub fn use_staging(&self) -> bool

Returns whether to use Let’s Encrypt staging environment

Trait Implementations

impl Clone for HttpsConfig

fn clone(&self) -> HttpsConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpsConfig

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

Formats the value using the given formatter.

impl Default for HttpsConfig

fn default() -> Self

Creates a default HTTPS configuration

Uses a placeholder email that should be replaced before deployment.

impl<'de> Deserialize<'de> for HttpsConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HttpsConfig

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HttpsConfig

impl StructuralPartialEq for HttpsConfig