Struct uriparse::authority::Password

pub struct Password<'password> { /* fields omitted */ }

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

Even though this library supports parsing the password from the user information, it should be noted that the format "username:password" is deprecated. Also, be careful logging this!

The password is case-sensitive. Furthermore, percent-encoding plays no role in equality checking for characters in the unreserved character set meaning that "password" and "p%61ssword" 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 password is normalized. If the password needs to be normalized, use the Password::normalize function.

Implementations

impl<'_> Password<'_>

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

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

pub fn as_str(&self) -> &str

Returns a str representation of the password.

Examples

use std::convert::TryFrom;

use uriparse::Password;

let password = Password::try_from("password").unwrap();
assert_eq!(password, "password");

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

Converts the Password into an owned copy.

If you construct the authority 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 password will just copy the references, and thus the lifetime will remain the same.

pub fn is_normalized(&self) -> bool

Returns whether the password is normalized.

A normalized password 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::Password;

let password = Password::try_from("password").unwrap();
assert!(password.is_normalized());

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

pub fn normalize(&mut self)

Normalizes the password 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 password is already normalized, the function will return immediately. Otherwise, if the password 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::Password;

let mut password = Password::try_from("password").unwrap();
password.normalize();
assert_eq!(password, "password");

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

Trait Implementations

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

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

Performs the conversion.

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

fn as_ref(&self) -> &str

Performs the conversion.

impl<'password> Clone for Password<'password>

fn clone(&self) -> Password<'password>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'password> Debug for Password<'password>

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

Formats the value using the given formatter.

impl<'_> Deref for Password<'_>

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl<'_> Display for Password<'_>

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

Formats the value using the given formatter.

impl<'_> Eq for Password<'_>

impl<'password> From<Password<'password>> for String

fn from(value: Password<'password>) -> String

Performs the conversion.

impl<'_> Hash for Password<'_>

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 Password<'_>

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 Password<'_>

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 Password<'_>

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<Password<'_>> for Password<'_>

fn eq(&self, other: &Password<'_>) -> 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<'password> PartialEq<Password<'password>> for [u8]

fn eq(&self, other: &Password<'password>) -> 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, 'password> PartialEq<Password<'password>> for &'a [u8]

fn eq(&self, other: &Password<'password>) -> 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<'password> PartialEq<Password<'password>> for str

fn eq(&self, other: &Password<'password>) -> 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, 'password> PartialEq<Password<'password>> for &'a str

fn eq(&self, other: &Password<'password>) -> 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 Password<'_>

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<'password> TryFrom<&'password [u8]> for Password<'password>

type Error = PasswordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'password> TryFrom<&'password str> for Password<'password>

type Error = PasswordError

The type returned in the event of a conversion error.

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

Performs the conversion.