Struct uriparse::authority::RegisteredName

pub struct RegisteredName<'name> { /* fields omitted */ }

A host that is a registered name (i.e. not an IP literal).

The registered name is case-insensitive meaning that "example.com" and "ExAmPlE.CoM" refer to the same registered name. Furthermore, percent-encoding plays no role in equality checking for characters in the unreserved character set meaning that "example.com" and "ex%61mple.com" are identical. Both of these attributes are reflected in the equality and hash functions.

However, be aware that just because percent-encoding plays no role in equality checking does not mean that the host is normalized. If the registered name needs to be normalized, use the RegisteredName::normalize function.

Implementations

impl<'_> RegisteredName<'_>

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

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

pub fn as_str(&self) -> &str

Returns a str representation of the registered name.

Examples

use std::convert::TryFrom;

use uriparse::RegisteredName;

let name = RegisteredName::try_from("example.com").unwrap();
assert_eq!(name.as_str(), "example.com");

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

Converts the RegisteredName into an owned copy.

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

pub fn is_normalized(&self) -> bool

Returns whether the registered name is normalized.

Registered names are considered normalized if all characters are lowercase, no bytes that are in the unreserved character set are percent-encoded, and all alphabetical characters in percent-encodings are uppercase.

This function runs in constant-time.

Examples

use std::convert::TryFrom;

use uriparse::RegisteredName;

let name = RegisteredName::try_from("example.com").unwrap();
assert!(name.is_normalized());

let mut name = RegisteredName::try_from("EXAMPLE.COM").unwrap();
assert!(!name.is_normalized());
name.normalize();
assert!(name.is_normalized());

pub fn normalize(&mut self)

Normalizes the registered name such that all characters are lowercase, no bytes that are in the unreserved character set are percent-encoded, and all alphabetical characters in percent-encodings are uppercase.

If the registered name is already normalized, the function will return immediately. Otherwise, if the registered name 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::RegisteredName;

let mut name = RegisteredName::try_from("example.com").unwrap();
name.normalize();
assert_eq!(name.to_string(), "example.com");

let mut name = RegisteredName::try_from("%ff%41").unwrap();
assert_eq!(name.to_string(), "%ff%41");
name.normalize();
assert_eq!(name.to_string(), "%FFA");

Trait Implementations

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

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

Performs the conversion.

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

fn as_ref(&self) -> &str

Performs the conversion.

impl<'name> Clone for RegisteredName<'name>

fn clone(&self) -> RegisteredName<'name>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'name> Debug for RegisteredName<'name>

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

Formats the value using the given formatter.

impl<'_> Display for RegisteredName<'_>

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

Formats the value using the given formatter.

impl<'_> Eq for RegisteredName<'_>

impl<'name> From<RegisteredName<'name>> for String

fn from(value: RegisteredName<'name>) -> String

Performs the conversion.

impl<'_> Hash for RegisteredName<'_>

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

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

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

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

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

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

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

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

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

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<'name> TryFrom<&'name [u8]> for RegisteredName<'name>

type Error = RegisteredNameError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'name> TryFrom<&'name str> for RegisteredName<'name>

type Error = RegisteredNameError

The type returned in the event of a conversion error.

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

Performs the conversion.