Struct Username

pub struct Username { /* private fields */ }

The username Attribute

Implementations

impl Username

pub fn new(user: &str) -> Result<Self, StunWriteError>

Create a new Username Attribute

Errors

• When the length of the username is longer than allowed in a STUN Message
• TODO: If converting through SASLPrep fails

Examples

let username = Username::new ("user").unwrap();
assert_eq!(username.username(), "user");

pub fn username(&self) -> &str

The username stored in a Username Attribute

Examples

let username = Username::new ("user").unwrap();
assert_eq!(username.username(), "user");

Trait Implementations

impl Attribute for Username

fn get_type(&self) -> AttributeType

Retrieve the type of an Attribute.

fn length(&self) -> u16

Retrieve the length of an Attribute. This is not the padded length as stored in a Message and does not include the size of the attribute header.

impl AttributeFromRaw<'_> for Username

fn from_raw_ref(raw: &RawAttribute<'_>) -> Result<Self, StunParseError>

where Self: Sized,

Produce an Attribute from a RawAttribute

fn from_raw(raw: RawAttribute<'a>) -> Result<Self, StunParseError>

where Self: Sized,

Produce an Attribute from a RawAttribute

impl AttributeStaticType for Username

const TYPE: AttributeType

The AttributeType

impl AttributeWrite for Username

fn to_raw(&self) -> RawAttribute<'_>

Produce a RawAttribute from this Attribute

fn write_into_unchecked(&self, dest: &mut [u8])

Write attribute to the provided destination buffer.

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 Display for Username

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

Formats the value using the given formatter.

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 TryFrom<&RawAttribute<'_>> for Username

type Error = StunParseError

The type returned in the event of a conversion error.

fn try_from(raw: &RawAttribute<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Username

impl StructuralPartialEq for Username