Struct ProfileName 

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

A validated LXD profile name following LXD naming requirements.

Valid profile 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 profile name can be used in DNS records, on the file system, in various security profiles and as the host name.

Examples

use torrust_tracker_deployer_lib::domain::ProfileName;

// Valid profile names - accepts both &str and String
let profile1 = ProfileName::new("test-profile")?;
let profile2 = ProfileName::new("web-server-profile".to_string())?;
let profile3 = ProfileName::new(format!("app-{}-profile", "prod"))?;

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

Implementations

impl ProfileName

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

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

Arguments

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

Returns

• Ok(ProfileName) - If the name is valid
• Err(ProfileNameError) - 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::ProfileName;

// Valid names - accepts both &str and String
let name1 = ProfileName::new("test-profile")?;
let name2 = ProfileName::new("web-01-profile".to_string())?;
let name3 = ProfileName::new(format!("app-{}-profile", "prod"))?;

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

pub fn as_str(&self) -> &str

Returns the profile name as a string slice.

Trait Implementations

impl AsRef<str> for ProfileName

fn as_ref(&self) -> &str

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

impl Clone for ProfileName

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 ProfileName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProfileName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProfileName

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

Formats the value using the given formatter.

impl Eq for ProfileName

impl From<ProfileName> for String

fn from(profile_name: ProfileName) -> Self

Converts to this type from the input type.

impl FromStr for ProfileName

type Err = ProfileNameError

The associated error which can be returned from parsing.

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

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

impl Hash for ProfileName

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 ProfileName

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProfileName

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 ProfileName

impl TryFrom<String> for ProfileName

type Error = ProfileNameError

The type returned in the event of a conversion error.

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

Performs the conversion.