Enum HealthCheckApiConfigError 

pub enum HealthCheckApiConfigError {
    DynamicPortNotSupported(SocketAddr),
    TlsProxyRequiresDomain(SocketAddr),
    LocalhostWithTls(SocketAddr),
}

Errors that can occur when creating a HealthCheckApiConfig

These errors represent domain invariant violations. Each variant provides context about what went wrong and enables the application layer to convert to user-friendly error messages.

Variants

DynamicPortNotSupported(SocketAddr)

Dynamic port assignment (port 0) is not supported

Port 0 tells the OS to assign a random available port, which is not suitable for deployment configuration where ports must be known.

TlsProxyRequiresDomain(SocketAddr)

TLS proxy is enabled but no domain is configured

When use_tls_proxy is true, a domain is required because Caddy needs the domain name to obtain Let’s Encrypt certificates.

LocalhostWithTls(SocketAddr)

Localhost address cannot be used with TLS proxy

Caddy runs in a separate container and cannot reach localhost addresses in the tracker container. Use 0.0.0.0 or a specific IP instead.

Implementations

impl HealthCheckApiConfigError

pub fn help(&self) -> &'static str

Provides detailed troubleshooting guidance for this error

This method follows the project’s tiered help system pattern, providing actionable guidance for resolving configuration issues.

Trait Implementations

impl Clone for HealthCheckApiConfigError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthCheckApiConfigError

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

Formats the value using the given formatter.

impl Display for HealthCheckApiConfigError

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

Formats the value using the given formatter.

impl Error for HealthCheckApiConfigError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<HealthCheckApiConfigError> for CreateConfigError

fn from(source: HealthCheckApiConfigError) -> Self

Converts to this type from the input type.

impl PartialEq for HealthCheckApiConfigError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HealthCheckApiConfigError