Struct EnvironmentName 

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

Validated environment name following restricted format rules

Environment names are used to isolate different deployment environments and must follow specific naming conventions for consistency and compatibility.

Examples

use torrust_tracker_deployer_types::EnvironmentName;

// Valid environment names
let dev = EnvironmentName::new("dev".to_string())?;
let staging = EnvironmentName::new("staging".to_string())?;
let e2e_config = EnvironmentName::new("e2e-config".to_string())?;

Implementations

impl EnvironmentName

pub fn new<S>(name: S) -> Result<EnvironmentName, EnvironmentNameError>

where S: Into<String>,

Creates a new EnvironmentName from a string with validation.

Arguments

• name - Environment name that can be converted to a string

Validation Rules

1. Non-empty: Must contain at least one character
2. Lowercase only: Only lowercase ASCII letters allowed
3. Numbers allowed: ASCII digits 0-9 are permitted
4. Dashes only: Only dashes (-) allowed as separators (no underscores or slashes)
5. No leading/trailing separators: Cannot start or end with dashes
6. No consecutive separators: Cannot contain multiple consecutive dashes
7. No leading numbers: Cannot start with a digit

Examples

// Valid names - accepts various string types
assert!(EnvironmentName::new("dev").is_ok());
assert!(EnvironmentName::new("e2e-config".to_string()).is_ok());
assert!(EnvironmentName::new(String::from("staging123")).is_ok());

// Invalid names
assert!(EnvironmentName::new("").is_err());              // Empty
assert!(EnvironmentName::new("Dev").is_err());           // Uppercase
assert!(EnvironmentName::new("dev_test").is_err());      // Underscore
assert!(EnvironmentName::new("123prod").is_err());       // Starts with number

Errors

Returns EnvironmentNameError with specific validation failure details and actionable guidance for fixing the name format.

pub fn as_str(&self) -> &str

Returns the environment name as a string slice

Examples

use torrust_tracker_deployer_types::EnvironmentName;

let env_name = EnvironmentName::new("production".to_string())?;
assert_eq!(env_name.as_str(), "production");

Trait Implementations

impl AsRef<str> for EnvironmentName

fn as_ref(&self) -> &str

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

impl Clone for EnvironmentName

fn clone(&self) -> EnvironmentName

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EnvironmentName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnvironmentName

fn deserialize<__D>( __deserializer: __D, ) -> Result<EnvironmentName, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EnvironmentName

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

Formats the value using the given formatter.

impl Eq for EnvironmentName

impl Hash for EnvironmentName

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

where __H: Hasher,

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 EnvironmentName

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EnvironmentName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EnvironmentName