Struct uriparse::fragment::Fragment

pub struct Fragment<'fragment> { /* fields omitted */ }

The fragment component as defined in [RFC3986, Section 3.5].

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

Methods

impl<'_> Fragment<'_>

pub fn as_borrowed(&self) -> Fragment

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

pub fn as_str(&self) -> &str

Returns a str representation of the fragment.

Examples

use std::convert::TryFrom;

use uriparse::Fragment;

let fragment = Fragment::try_from("fragment").unwrap();
assert_eq!(fragment.as_str(), "fragment");

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

Converts the Fragment into an owned copy.

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

pub fn is_normalized(&self) -> bool

Returns whether the fragment is normalized.

A normalized fragment 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::Fragment;

let fragment = Fragment::try_from("fragment").unwrap();
assert!(fragment.is_normalized());

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

pub fn normalize(&mut self)

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

let mut fragment = Fragment::try_from("fragment").unwrap();
fragment.normalize();
assert_eq!(fragment, "fragment");

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

Trait Implementations

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

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

Performs the conversion.

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

fn as_ref(&self) -> &str

Performs the conversion.

impl<'_> PartialEq<Fragment<'_>> for Fragment<'_>

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

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<'fragment> PartialEq<Fragment<'fragment>> for [u8]

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

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, 'fragment> PartialEq<Fragment<'fragment>> for &'a [u8]

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

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<'fragment> PartialEq<Fragment<'fragment>> for str

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

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<'a, 'fragment> PartialEq<Fragment<'fragment>> for &'a str

fn eq(&self, other: &Fragment<'fragment>) -> 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<'fragment> From<Fragment<'fragment>> for String

fn from(value: Fragment<'fragment>) -> Self

Performs the conversion.

impl<'fragment> Clone for Fragment<'fragment>

fn clone(&self) -> Fragment<'fragment>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'_> Eq for Fragment<'_>

impl<'_> Display for Fragment<'_>

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

Formats the value using the given formatter.

impl<'fragment> Debug for Fragment<'fragment>

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

Formats the value using the given formatter.

impl<'_> Hash for Fragment<'_>

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<'_> Deref for Fragment<'_>

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl<'fragment> TryFrom<&'fragment [u8]> for Fragment<'fragment>

type Error = InvalidFragment

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'fragment> TryFrom<&'fragment str> for Fragment<'fragment>

type Error = InvalidFragment

The type returned in the event of a conversion error.

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

Performs the conversion.