Struct pct_str::PctStr

pub struct PctStr { /* fields omitted */ }

Percent-Encoded string slice.

This is the equivalent of str for percent-encoded strings. This is an unsized type, meaning that it must always be used behind a pointer like & or Box. For an owned version of this type, see PctString.

Examples

use pct_str::PctStr;

let buffer = "Hello%20World%21";
let pct_str = PctStr::new(buffer).unwrap();

// You can compare percent-encoded strings with a regular string.
assert!(pct_str == "Hello World!");

// The underlying string is unchanged.
assert!(pct_str.as_str() == "Hello%20World%21");

// Just as a regular string, you can iterate over the
// encoded characters of `pct_str` with [`PctStr::chars`].
for c in pct_str.chars() {
	print!("{}", c);
}

// You can decode the string and every remove percent-encoded characters
// with the [`PctStr::decode`] method.
let decoded_string: String = pct_str.decode();
println!("{}", decoded_string);

Implementations

impl PctStr

pub fn new<S: AsRef<str> + ?Sized>(str: &S) -> Result<&PctStr>

Create a new percent-encoded string slice.

The input slice is checked for correct percent-encoding. If the test fails, a InvalidEncoding error is returned.

pub unsafe fn new_unchecked<S: AsRef<str> + ?Sized>(str: &S) -> &PctStr

Create a new percent-encoded string slice without checking for correct encoding.

This is an unsafe function. The resulting string slice will have an undefined behaviour if the input slice is not percent-encoded.

pub fn len(&self) -> usize

Length of the string slice, in bytes.

Note that two percent-encoded strings with different lengths may represent the same string.

pub fn as_str(&self) -> &str

Get the underlying percent-encoded string slice.

pub fn chars(&self) -> Chars<'_>

Iterate over the encoded characters of the string.

pub fn decode(&self) -> String

Decoding.

Return the string with the percent-encoded characters decoded.

Trait Implementations

impl Debug for PctStr

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

Formats the value using the given formatter.

impl Display for PctStr

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

Formats the value using the given formatter.

impl Eq for PctStr

impl Hash for PctStr

fn hash<H: Hasher>(&self, hasher: &mut H)

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 Ord for PctStr

fn cmp(&self, other: &PctStr) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<PctStr> for PctStr

fn eq(&self, other: &PctStr) -> 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<PctStr> for PctString

fn eq(&self, other: &PctStr) -> 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<PctString> for PctStr

fn eq(&self, other: &PctString) -> 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 PctStr

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 PartialOrd<PctStr> for PctStr

fn partial_cmp(&self, other: &PctStr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<PctStr> for PctString

fn partial_cmp(&self, other: &PctStr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<PctString> for PctStr

fn partial_cmp(&self, other: &PctString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.