Struct pct_str::PctString

pub struct PctString { /* fields omitted */ }

Owned, mutable percent-encoded string.

This is the equivalent of String for percent-encoded strings. It implements Deref to PctStr meaning that all methods on PctStr slices are available on PctString values as well.

Implementations

impl PctString

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

Create a new owned percent-encoded string.

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

pub fn encode<I: Iterator<Item = char>, E: Encoder>(
    src: I,
    encoder: E
) -> PctString

Encode a string into a percent-encoded string.

This function takes an Encoder instance to decide which character of the string must be encoded.

Example

use pct_str::{PctString, URIReserved};

let pct_string = PctString::encode("Hello World!".chars(), URIReserved);
println!("{}", pct_string.as_str()); // => Hello World%21

pub fn as_pct_str(&self) -> &PctStr

Return this string as a borrowed percent-encoded string slice.

pub fn into_string(self) -> String

Return the internal string of the PctString, consuming it

Methods from Deref<Target = PctStr>

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 PctString

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

Formats the value using the given formatter.

impl Deref for PctString

type Target = PctStr

The resulting type after dereferencing.

fn deref(&self) -> &PctStr

Dereferences the value.

impl Display for PctString

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

Formats the value using the given formatter.

impl Eq for PctString

impl Hash for PctString

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<'_> PartialEq<&'_ str> for PctString

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 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<PctString> for PctString

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 PctString

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

impl PartialOrd<PctString> for PctString

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.