Struct Username 

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

A validated Linux system username following Linux naming requirements.

Valid usernames must fulfill the following requirements:

• The username must be between 1 and 32 characters long
• The username must start with a letter (a-z, A-Z) or underscore (_)
• The username can contain lowercase letters, digits, underscores, and hyphens
• The username cannot contain spaces or other special characters

These requirements ensure that the username can be used for:

• SSH authentication
• File and directory ownership
• Process ownership and management
• System user identification

Implementations

impl Username

pub fn new<S>(username: S) -> Result<Username, UsernameError>

where S: Into<String>,

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

Arguments

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

Returns

• Ok(Username) - If the username is valid
• Err(UsernameError) - If the username violates Linux naming requirements

Errors

This function will return an error if the username violates any Linux naming requirements:

• Empty username
• Username longer than 32 characters
• Username contains invalid characters
• Username starts with a digit or invalid character

Examples

use torrust_tracker_deployer_types::Username;

// Valid usernames - accepts both &str and String
let user1 = Username::new("torrust")?;
let user2 = Username::new("user_123".to_string())?;
let user3 = Username::new("deploy-user")?;
let user4 = Username::new("_service")?;

// Invalid usernames
assert!(Username::new("").is_err());
assert!(Username::new("user@domain").is_err());
assert!(Username::new("123user").is_err());

pub fn as_str(&self) -> &str

Returns the username as a string slice.

Trait Implementations

impl AsRef<str> for Username

fn as_ref(&self) -> &str

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

impl Clone for Username

fn clone(&self) -> Username

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Username

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Username

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Username

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

Formats the value using the given formatter.

impl Eq for Username

impl FromStr for Username

type Err = UsernameError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Username, UsernameError>

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

impl Hash for Username

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 Username

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Username

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 Username