Struct Username 

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

Available on crate feature sys only.

System username.

This type provides type-safe system usernames following POSIX rules. It uses the newtype pattern with #[repr(transparent)] for zero-cost abstraction.

Implementations

impl Username

pub const MAX_LEN: usize = 32

Maximum length of a username (POSIX)

pub fn new(s: &str) -> Result<Self, UsernameError>

Creates a new username from a string.

Errors

Returns an error UsernameError if the string is not a valid username.

pub fn as_str(&self) -> &str

Returns the username as a string slice.

pub const fn as_inner(&self) -> &String<32>

Returns a reference to the underlying heapless::String.

pub fn into_inner(self) -> String<32>

Consumes this username and returns the underlying string.

pub fn is_system_user(&self) -> bool

Returns true if this is a system user.

System users typically start with underscore or are well-known system accounts.

pub fn is_service_account(&self) -> bool

Returns true if this is a service account.

Service accounts typically start with “svc-” or “service-”.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Username

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

Formats the value using the given formatter.

impl FromStr for Username

type Err = UsernameError

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 Username

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 Username

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Username

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Username

type Error = UsernameError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Username

impl StructuralPartialEq for Username