Struct InternalConfig 

pub struct InternalConfig {
    pub build_dir: PathBuf,
    pub data_dir: PathBuf,
}

Internal paths and configuration derived from user inputs

This struct contains fields that are derived automatically from user inputs and are not directly controlled by users. These represent internal implementation details for organizing build artifacts and data.

Examples

use torrust_tracker_deployer_lib::domain::environment::internal_config::InternalConfig;
use std::path::PathBuf;

let internal_config = InternalConfig {
    build_dir: PathBuf::from("build/production"),
    data_dir: PathBuf::from("data/production"),
};

Fields

build_dir: PathBuf

Build directory for this environment (derived from environment name)

data_dir: PathBuf

Data directory for this environment (derived from environment name)

Implementations

impl InternalConfig

pub fn new(env_name: &EnvironmentName) -> Self

Creates a new InternalConfig with auto-generated directories

Arguments

• env_name - The environment name used to generate directories

Returns

A new InternalConfig with:

• data_dir: ./data/{env_name}
• build_dir: ./build/{env_name}

Examples

use torrust_tracker_deployer_lib::domain::environment::internal_config::InternalConfig;
use torrust_tracker_deployer_lib::domain::environment::EnvironmentName;
use std::path::PathBuf;

let env_name = EnvironmentName::new("production".to_string())?;
let config = InternalConfig::new(&env_name);

assert_eq!(config.data_dir, PathBuf::from("./data/production"));
assert_eq!(config.build_dir, PathBuf::from("./build/production"));

pub fn with_working_dir(env_name: &EnvironmentName, working_dir: &Path) -> Self

Creates a new InternalConfig with directories relative to a working directory

This version creates absolute paths by prepending the working directory to the generated data and build directories.

Arguments

• env_name - The environment name used to generate directories
• working_dir - The base working directory for operations

Returns

A new InternalConfig with:

• data_dir: {working_dir}/data/{env_name}
• build_dir: {working_dir}/build/{env_name}

Examples

use torrust_tracker_deployer_lib::domain::environment::internal_config::InternalConfig;
use torrust_tracker_deployer_lib::domain::environment::EnvironmentName;
use std::path::PathBuf;

let env_name = EnvironmentName::new("production".to_string())?;
let working_dir = PathBuf::from("/opt/deployments");
let config = InternalConfig::with_working_dir(&env_name, &working_dir);

assert_eq!(config.data_dir, PathBuf::from("/opt/deployments/data/production"));
assert_eq!(config.build_dir, PathBuf::from("/opt/deployments/build/production"));

pub fn templates_dir(&self) -> PathBuf

Returns the templates directory for this environment

Path: data/{env_name}/templates/

pub fn traces_dir(&self) -> PathBuf

Returns the traces directory for this environment

Path: data/{env_name}/traces/

pub fn ansible_build_dir(&self) -> PathBuf

Returns the ansible build directory

Path: build/{env_name}/ansible

pub fn tofu_build_dir_for_provider(&self, provider: Provider) -> PathBuf

Returns the OpenTofu build directory for a specific provider

Path: build/{env_name}/tofu/{provider_name}

Arguments

• provider - The provider type (LXD, Hetzner, etc.)

pub fn ansible_templates_dir(&self) -> PathBuf

Returns the ansible templates directory

Path: data/{env_name}/templates/ansible

pub fn tofu_templates_dir(&self) -> PathBuf

Returns the tofu templates directory

Path: data/{env_name}/templates/tofu

Trait Implementations

impl Clone for InternalConfig

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 InternalConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InternalConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for InternalConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.