Struct Encoded

#[repr(transparent)]
pub struct Encoded<Str>(pub Str);

Wrapper type that implements Display. Encodes on the fly, without allocating. Percent-encodes every byte except alphanumerics and -, _, ., ~. Assumes UTF-8 encoding.

use urlencoding::Encoded;
format!("{}", Encoded("hello!"));

Tuple Fields

0: Str

Implementations

impl<Str: AsRef<[u8]>> Encoded<Str>

pub fn new(string: Str) -> Self

Long way of writing Encoded(data)

Takes any string-like type or a slice of bytes, either owned or borrowed.

pub fn to_str(&self) -> Cow<'_, str>

pub fn to_string(&self) -> String

Perform urlencoding to a string

pub fn write<W: Write>(&self, writer: &mut W) -> Result<()>

Perform urlencoding into a writer

pub fn append_to(&self, string: &mut String)

Perform urlencoding into a string

impl<'a> Encoded<&'a str>

pub fn str(string: &'a str) -> Self

Same as new, but hints a more specific type, so you can avoid errors about AsRef<[u8]> not implemented on references-to-references.

Trait Implementations

impl<Str: Clone> Clone for Encoded<Str>

fn clone(&self) -> Encoded<Str>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Str: Debug> Debug for Encoded<Str>

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

Formats the value using the given formatter.

impl<String: AsRef<[u8]>> Display for Encoded<String>

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

Formats the value using the given formatter.

impl<Str: Hash> Hash for Encoded<Str>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Str: Ord> Ord for Encoded<Str>

fn cmp(&self, other: &Encoded<Str>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Str: PartialEq> PartialEq for Encoded<Str>

fn eq(&self, other: &Encoded<Str>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Str: PartialOrd> PartialOrd for Encoded<Str>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<Str: Copy> Copy for Encoded<Str>

impl<Str: Eq> Eq for Encoded<Str>

impl<Str> StructuralPartialEq for Encoded<Str>