Struct uriparse::authority::Username

pub struct Username<'username> { /* fields omitted */ }

The username component of the authority as defined in [RFC3986, Section 3.2.1].

The username is case-sensitive. Furthermore, percent-encoding plays no role in equality checking for characters in the unreserved character set meaning that "username" and "usern%61me" are identical. Both of these attributes are reflected in the equality and hash functions.

Be aware that just because percent-encoding plays no role in equality checking does not mean that the username is normalized. If the username needs to be normalized, use the Username::normalize function.

Implementations

impl<'_> Username<'_>

pub fn as_borrowed(&self) -> Username<'_>

Returns a new username which is identical but has a lifetime tied to this username.

pub fn as_str(&self) -> &str

Returns a str representation of the username.

Examples

use std::convert::TryFrom;

use uriparse::Username;

let username = Username::try_from("username").unwrap();
assert_eq!(username.as_str(), "username");

pub fn into_owned(self) -> Username<'static>

Converts the Username into an owned copy.

If you construct the username from a source with a non-static lifetime, you may run into lifetime problems due to the way the struct is designed. Calling this function will ensure that the returned value has a static lifetime.

This is different from just cloning. Cloning the username will just copy the references, and thus the lifetime will remain the same.

pub fn is_normalized(&self) -> bool

Returns whether the username is normalized.

A normalized username will have no bytes that are in the unreserved character set percent-encoded and all alphabetical characters in percent-encodings will be uppercase.

This function runs in constant-time.

Examples

use std::convert::TryFrom;

use uriparse::Username;

let username = Username::try_from("username").unwrap();
assert!(username.is_normalized());

let mut username = Username::try_from("%ff%ff").unwrap();
assert!(!username.is_normalized());
username.normalize();
assert!(username.is_normalized());

pub fn normalize(&mut self)

Normalizes the username such that it will have no bytes that are in the unreserved character set percent-encoded and all alphabetical characters in percent-encodings will be uppercase.

If the username is already normalized, the function will return immediately. Otherwise, if the username is not owned, this function will perform an allocation to clone it. The normalization itself though, is done in-place with no extra memory allocations required.

Examples

use std::convert::TryFrom;

use uriparse::Username;

let mut username = Username::try_from("username").unwrap();
username.normalize();
assert_eq!(username, "username");

let mut username = Username::try_from("%ff%41").unwrap();
assert_eq!(username, "%ff%41");
username.normalize();
assert_eq!(username, "%FFA");

Trait Implementations

impl<'_> AsRef<[u8]> for Username<'_>

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'_> AsRef<str> for Username<'_>

fn as_ref(&self) -> &str

Performs the conversion.

impl<'username> Clone for Username<'username>

fn clone(&self) -> Username<'username>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'username> Debug for Username<'username>

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

Formats the value using the given formatter.

impl<'_> Deref for Username<'_>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'_> Display for Username<'_>

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

Formats the value using the given formatter.

impl<'username> Eq for Username<'username>

impl<'username> From<Username<'username>> for String

fn from(value: Username<'username>) -> String

Performs the conversion.

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, 

Feeds a slice of this type into the given Hasher.

impl<'a, '_> PartialEq<&'a [u8]> for Username<'_>

fn eq(&self, other: &&'a [u8]) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, '_> PartialEq<&'a str> for Username<'_>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<[u8]> for Username<'_>

fn eq(&self, other: &[u8]) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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 ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'username> PartialEq<Username<'username>> for [u8]

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'username> PartialEq<Username<'username>> for &'a [u8]

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'username> PartialEq<Username<'username>> for str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'username> PartialEq<Username<'username>> for &'a str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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 ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'username> TryFrom<&'username [u8]> for Username<'username>

type Error = UsernameError

The type returned in the event of a conversion error.

fn try_from(value: &'username [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'username> TryFrom<&'username str> for Username<'username>

type Error = UsernameError

The type returned in the event of a conversion error.

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

Performs the conversion.