Struct stun_rs::attributes::stun::UserName

pub struct UserName(_);

The USER-NAME attribute is used for message integrity. It identifies the user name and password combination used in the message-integrity check. It MUST contain a UTF-8-encoded RFC3629 sequence of fewer than 509 bytes and MUST have been processed using the OpaqueString profile RFC8265

Examples

 let user_name = UserName::try_from("username")?;
 // UserName uses the OpaqueString profie to compare strings
 assert_eq!(user_name, "username");

 // Control characters like TAB `U+0009` are disallowed by OpaqueString profile
 let result = UserName::try_from("user\u{0009}name");
 assert_eq!(result.expect_err("Error expected"), StunErrorType::InvalidParam);

Implementations

impl UserName

pub fn new<S>(value: S) -> Result<Self, StunError>where
    S: AsRef<str>,

Creates a UserName if the value provided can be processed using the OpaqueString profile RFC8265

pub fn as_str(&self) -> &str

Returns a slice representation of the user name value

Trait Implementations

impl AsRef<String> for UserName

fn as_ref(&self) -> &String

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

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 copy 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 From<UserName> for StunAttribute

fn from(value: UserName) -> Self

Converts to this type from the input type.

impl PartialEq<&str> for UserName

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<String> for UserName

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<UserName> for &str

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<UserName> for String

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<UserName> for UserName

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<str> for UserName

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StunAttributeType for UserName

fn get_type() -> AttributeTypewhere
    Self: Sized,

Returns the STUN attribute type.

fn attribute_type(&self) -> AttributeType

Returns the STUN attribute type of this instance.

impl TryFrom<&String> for UserName

type Error = StunError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for UserName

type Error = StunError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for UserName

type Error = StunError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for UserName

impl StructuralEq for UserName

impl StructuralPartialEq for UserName