Enum ProviderConfig 

pub enum ProviderConfig {
    Lxd(LxdConfig),
    Hetzner(HetznerConfig),
}

Provider-specific configuration (Domain Type)

Each variant contains the configuration fields specific to that provider using validated domain types (e.g., ProfileName instead of String).

This is a tagged enum that serializes/deserializes based on the "provider" field.

Note on Layer Placement

This is a domain type with validated fields. For JSON deserialization, use ProviderSection in the application layer, then convert to this type.

Examples

use torrust_tracker_deployer_lib::domain::provider::{ProviderConfig, LxdConfig, Provider};
use torrust_tracker_deployer_lib::domain::ProfileName;

let lxd_config = ProviderConfig::Lxd(LxdConfig {
    profile_name: ProfileName::new("torrust-profile").unwrap(),
});

assert_eq!(lxd_config.provider(), Provider::Lxd);
assert_eq!(lxd_config.provider_name(), "lxd");

Variants

Lxd(LxdConfig)

LXD provider configuration

Hetzner(HetznerConfig)

Hetzner provider configuration

Implementations

impl ProviderConfig

pub fn provider(&self) -> Provider

Returns the provider type.

Examples

use torrust_tracker_deployer_lib::domain::provider::{ProviderConfig, LxdConfig, Provider};
use torrust_tracker_deployer_lib::domain::ProfileName;

let config = ProviderConfig::Lxd(LxdConfig {
    profile_name: ProfileName::new("test").unwrap(),
});
assert_eq!(config.provider(), Provider::Lxd);

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

Returns the provider name as used in directory paths.

This is a convenience method that delegates to self.provider().as_str().

Examples

use torrust_tracker_deployer_lib::domain::provider::{ProviderConfig, LxdConfig};
use torrust_tracker_deployer_lib::domain::ProfileName;

let config = ProviderConfig::Lxd(LxdConfig {
    profile_name: ProfileName::new("test").unwrap(),
});
assert_eq!(config.provider_name(), "lxd");

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

Returns a human-readable display name for the provider.

This method converts the internal provider identifier to a user-friendly format suitable for display in CLI output, logs, or documentation.

Examples

use torrust_tracker_deployer_lib::domain::provider::{ProviderConfig, LxdConfig, HetznerConfig};
use torrust_tracker_deployer_lib::domain::ProfileName;
use torrust_tracker_deployer_lib::shared::secrets::ApiToken;

let lxd_config = ProviderConfig::Lxd(LxdConfig {
    profile_name: ProfileName::new("test").unwrap(),
});
assert_eq!(lxd_config.provider_display_name(), "LXD");

let hetzner_config = ProviderConfig::Hetzner(HetznerConfig {
    api_token: ApiToken::from("token"),
    server_type: "cx22".to_string(),
    location: "nbg1".to_string(),
    image: "ubuntu-24.04".to_string(),
});
assert_eq!(hetzner_config.provider_display_name(), "Hetzner Cloud");

pub fn as_lxd(&self) -> Option<&LxdConfig>

Returns a reference to the LXD configuration if this is an LXD provider.

Returns

• Some(&LxdConfig) if the provider is LXD
• None otherwise

Examples

use torrust_tracker_deployer_lib::domain::provider::{ProviderConfig, LxdConfig, HetznerConfig};
use torrust_tracker_deployer_lib::domain::ProfileName;
use torrust_tracker_deployer_lib::shared::secrets::ApiToken;

let lxd_config = ProviderConfig::Lxd(LxdConfig {
    profile_name: ProfileName::new("test").unwrap(),
});
assert!(lxd_config.as_lxd().is_some());

let hetzner_config = ProviderConfig::Hetzner(HetznerConfig {
    api_token: ApiToken::from("token"),
    server_type: "cx22".to_string(),
    location: "nbg1".to_string(),
    image: "ubuntu-24.04".to_string(),
});
assert!(hetzner_config.as_lxd().is_none());

pub fn as_hetzner(&self) -> Option<&HetznerConfig>

Returns a reference to the Hetzner configuration if this is a Hetzner provider.

Returns

• Some(&HetznerConfig) if the provider is Hetzner
• None otherwise

Trait Implementations

impl Clone for ProviderConfig

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 ProviderConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ProviderConfig

impl PartialEq for ProviderConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProviderConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProviderConfig

impl TryFrom<ProviderSection> for ProviderConfig

type Error = CreateConfigError

The type returned in the event of a conversion error.

fn try_from(section: ProviderSection) -> Result<Self, Self::Error>

Performs the conversion.