Struct InstanceName 

pub struct InstanceName(/* private fields */);

A validated instance name following LXD naming requirements.

This type ensures that names are valid for both LXD virtual machines used in production deployments and Docker containers used in end-to-end testing.

Valid instance names must fulfill the following requirements:

• The name must be between 1 and 63 characters long
• The name must contain only letters, numbers and dashes from the ASCII table
• The name must not start with a digit or a dash
• The name must not end with a dash

These requirements ensure that the instance name can be used in DNS records, on the file system, in various security profiles and as the host name.

Use Cases

• LXD Virtual Machines: Naming VMs provisioned for deployment environments
• Testing Containers: Naming Docker containers in E2E test scenarios

Examples

use torrust_tracker_deployer_lib::domain::InstanceName;

// Valid instance names - accepts both &str and String
let vm_instance = InstanceName::new("torrust-vm-prod")?;
let test_container = InstanceName::new("test-container-01".to_string())?;
let dynamic_name = InstanceName::new(format!("app-{}", "staging"))?;

// Invalid instance names
assert!(InstanceName::new("").is_err());
assert!(InstanceName::new("test-").is_err());
assert!(InstanceName::new("-test").is_err());
assert!(InstanceName::new("1test").is_err());

Implementations

impl InstanceName

pub fn new<S: Into<String>>(name: S) -> Result<Self, InstanceNameError>

Creates a new InstanceName from a string if it’s valid.

This method validates that the provided name meets the requirements for both LXD virtual machines and testing containers.

Arguments

• name - The instance name to validate (accepts &str, String, or anything that implements Into<String>)

Returns

• Ok(InstanceName) - If the name is valid
• Err(InstanceNameError) - If the name violates LXD naming requirements

Errors

This function will return an error if the name violates any LXD naming requirements:

• Empty name
• Name longer than 63 characters
• Name contains non-ASCII letters, numbers, or dashes
• Name starts with a digit or dash
• Name ends with a dash

Examples

use torrust_tracker_deployer_lib::domain::InstanceName;

// Valid names for VMs and containers - accepts both &str and String
let vm_name = InstanceName::new("torrust-vm-prod")?;
let container_name = InstanceName::new("test-web-01".to_string())?;
let dynamic_name = InstanceName::new(format!("app-{}", "staging"))?;

// Invalid names
assert!(InstanceName::new("").is_err());
assert!(InstanceName::new("test-").is_err());
assert!(InstanceName::new("-test").is_err());
assert!(InstanceName::new("1test").is_err());

pub fn as_str(&self) -> &str

Returns the instance name as a string slice.

Trait Implementations

impl AsRef<str> for InstanceName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for InstanceName

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 InstanceName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstanceName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InstanceName

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

Formats the value using the given formatter.

impl Eq for InstanceName

impl FromStr for InstanceName

type Err = InstanceNameError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, InstanceNameError>

Parses a string s to return a value of this type.

impl Hash for InstanceName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for InstanceName

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for InstanceName

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 InstanceName

impl TryFrom<String> for InstanceName

type Error = InstanceNameError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, InstanceNameError>

Performs the conversion.