Struct librice::stun::attribute::Username

pub struct Username { /* private fields */ }

The username Attribute

Implementations

impl Username

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

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");

Examples found in repository

src/conncheck.rs (line 173)

    fn generate_stun_request(
        conncheck: Arc<ConnCheck>,
        username: String,
        controlling: bool,
        tie_breaker: u64,
    ) -> Result<StunRequest, StunError> {
        let mut msg = Message::new_request(BINDING);

        // XXX: this needs to be the priority as if the candidate was peer-reflexive
        msg.add_attribute(Priority::new(conncheck.pair.local.priority))?;
        if controlling {
            msg.add_attribute(IceControlling::new(tie_breaker))?;
        } else {
            msg.add_attribute(IceControlled::new(tie_breaker))?;
        }
        if conncheck.nominate {
            msg.add_attribute(UseCandidate::new())?;
        }
        msg.add_attribute(Username::new(&username)?)?;
        msg.add_message_integrity(&conncheck.agent.local_credentials().unwrap())?;
        msg.add_fingerprint()?;

        let to = conncheck.pair.remote.address;
        conncheck.agent.stun_request_transaction(&msg, to)?.build()
    }

pub fn username(&self) -> &str

The username stored in a Username Attribute

Examples

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

Examples found in repository

src/conncheck.rs (line 1927)

fn validate_username(username: Username, local_credentials: &Credentials) -> bool {
    let username = username.username().as_bytes();
    let local_user = local_credentials.ufrag.as_bytes();
    if local_user.len()
        == local_user
            .iter()
            .zip(username)
            .take_while(|(l, r)| l == r)
            .count()
    {
        true
    } else {
        debug!("binding request failed username validation");
        false
    }
}

Trait Implementations

impl Attribute for Username

fn get_type(&self) -> AttributeType

Retrieve the AttributeType of an Attribute

fn length(&self) -> u16

Retrieve the length of an Attribute. This is not the padded length as stored in a Message

fn to_raw(&self) -> RawAttribute

Convert an Attribute to a RawAttribute

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

Convert an Attribute from a RawAttribute

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

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

Formats the value using the given formatter.

impl From<Username> for RawAttribute

fn from(f: Username) -> Self

Converts to this type from the input type.

impl TryFrom<&RawAttribute> for Username

type Error = StunParseError

The type returned in the event of a conversion error.

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

Performs the conversion.