Struct RuntimeOutputs 

pub struct RuntimeOutputs { /* private fields */ }

Runtime outputs generated during deployment operations

This struct contains fields that are generated during deployment operations and represent the runtime state of deployed infrastructure. Fields are private to protect invariants and provide semantic clarity through setters.

Lifecycle

Fields are populated at different stages of the deployment lifecycle:

• Creation: All fields are None (use RuntimeOutputs::new())
• After Provisioning: instance_ip and provision_method are set (use record_provisioning() or record_registration())
• After Run Command: service_endpoints is set (use record_services_started())

Future Fields

This struct is expected to grow as deployment operations become more complex:

• container_id: Option<String> - Container/VM identifier
• resource_metrics: Option<ResourceMetrics> - CPU, memory, disk usage

Examples

use torrust_tracker_deployer_lib::domain::environment::runtime_outputs::{RuntimeOutputs, ProvisionMethod};
use std::net::{IpAddr, Ipv4Addr};

// Create empty runtime outputs
let mut runtime_outputs = RuntimeOutputs::new();
assert!(runtime_outputs.instance_ip().is_none());

// After provisioning, record the IP and method
let ip = IpAddr::V4(Ipv4Addr::new(192, 168, 1, 100));
runtime_outputs.record_provisioning(ip);
assert_eq!(runtime_outputs.instance_ip(), Some(ip));
assert_eq!(runtime_outputs.provision_method(), Some(ProvisionMethod::Provisioned));

Implementations

impl RuntimeOutputs

pub fn new() -> Self

Creates new empty runtime outputs

All fields are initialized to None, representing an environment that has not yet been provisioned or run.

Examples

use torrust_tracker_deployer_lib::domain::environment::runtime_outputs::RuntimeOutputs;

let outputs = RuntimeOutputs::new();
assert!(outputs.instance_ip().is_none());
assert!(outputs.provision_method().is_none());
assert!(outputs.service_endpoints().is_none());

pub fn instance_ip(&self) -> Option<IpAddr>

Returns the instance IP address if available

This is None until the environment has been provisioned or registered.

pub fn provision_method(&self) -> Option<ProvisionMethod>

Returns how the instance was provisioned

• None: Unknown or legacy state
• Some(Provisioned): Created via provision command
• Some(Registered): Connected via register command

pub fn service_endpoints(&self) -> Option<&ServiceEndpoints>

Returns the service endpoints if available

This is None until the run command has started services successfully.

pub fn record_provisioning(&mut self, ip: IpAddr)

Records that provisioning has completed with the given instance IP

Call this after the provision command successfully creates infrastructure. Sets both instance_ip and provision_method to Provisioned.

Arguments

• ip - The IP address of the newly provisioned instance

pub fn record_registration(&mut self, ip: IpAddr)

Records that an existing instance has been registered

Call this after the register command connects to existing infrastructure. Sets both instance_ip and provision_method to Registered.

Arguments

• ip - The IP address of the registered instance

pub fn record_services_started(&mut self, endpoints: ServiceEndpoints)

Records that services have been started with the given endpoints

Call this after the run command successfully starts all services. The endpoints can then be displayed to users or used for health checks.

Arguments

• endpoints - The URLs for all running services

pub fn set_instance_ip(&mut self, ip: IpAddr)

Sets the instance IP directly

Prefer record_provisioning() or record_registration() which also set the provision method. This method is provided for cases where only the IP needs to be updated (e.g., deserialization workarounds).

pub fn set_provision_method(&mut self, method: ProvisionMethod)

Sets the provision method directly

Prefer record_provisioning() or record_registration() which also set the instance IP. This method is provided for backward compatibility.

Trait Implementations

impl Clone for RuntimeOutputs

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 RuntimeOutputs

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

Formats the value using the given formatter.

impl Default for RuntimeOutputs

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RuntimeOutputs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RuntimeOutputs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.