pub struct PctStr { /* private fields */ }
Expand description
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§
source§impl PctStr
impl PctStr
sourcepub fn new<S: AsRef<str> + ?Sized>(str: &S) -> Result<&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.
Examples found in repository?
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
fn main() -> pct_str::Result<()> {
// [`PctStr`] is the equivalent of [`str`] for percent-encoded strings.
let buffer = "Hello%20World%21";
// It is just a reference to `buffer`.
// It can fail if `buffer` is not a valid percent-encoded string.
let pct_str = PctStr::new(buffer)?;
// You can compare percent-encoded strings with a regular string.
assert!(pct_str == "Hello World!"); // => true
// The underlying string is unchanged.
assert!(pct_str.as_str() == "Hello%20World%21"); // => true
// 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);
}
// => Hello World!
println!("");
// 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);
// => Hello World!
Ok(())
}
More examples
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
fn main() -> pct_str::Result<()> {
// [`PctString`] is the equivalent of [`String`] for
// percent-encoded strings.
// The data is owned by `pct_string`.
let pct_string = PctString::new("Hello%20World%21")?;
// You can compare percent-encoded strings with a regular string.
assert!(pct_string == "Hello World!");
// The underlying string is percent-encoded.
assert!(pct_string.as_str() == "Hello%20World%21");
// You can get a reference to the string as a [`PctStr`].
assert!(pct_string.as_pct_str() == PctStr::new("Hello%20World%21")?);
// Just as a regular string, you can iterate over the
// encoded characters of `pct_str` with [`PctString::chars`].
for c in pct_string.chars() {
println!("{}", c);
}
// You can decode the string and every remove percent-encoded characters
// with the [`PctStr::decode`] method.
let decoded_string: String = pct_string.decode();
println!("{}", decoded_string);
Ok(())
}
sourcepub unsafe fn new_unchecked<S: AsRef<str> + ?Sized>(str: &S) -> &PctStr
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.
Safety
The input str
must be a valid percent-encoded string.
sourcepub fn len(&self) -> usize
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.
sourcepub fn as_str(&self) -> &str
pub fn as_str(&self) -> &str
Get the underlying percent-encoded string slice.
Examples found in repository?
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
fn main() -> pct_str::Result<()> {
// You can encode any string into a percent-encoded string
// using the [`PctString::encode`] function.
// It takes a `char` iterator and a [`Encoder`] instance deciding which characters
// to encode.
let pct_string = PctString::encode("Hello World!".chars(), URIReserved);
// [`URIReserved`] is a predefined encoder for URI-reserved characters.
println!("{}", pct_string.as_str());
// => Hello World%21
// You can create your own encoder by implementing the [`Encoder`] trait.
let pct_string = PctString::encode("Hello World!".chars(), CustomEncoder);
println!("{}", pct_string.as_str());
// => %48ello %57orld%21
Ok(())
}
More examples
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
fn main() -> pct_str::Result<()> {
// [`PctStr`] is the equivalent of [`str`] for percent-encoded strings.
let buffer = "Hello%20World%21";
// It is just a reference to `buffer`.
// It can fail if `buffer` is not a valid percent-encoded string.
let pct_str = PctStr::new(buffer)?;
// You can compare percent-encoded strings with a regular string.
assert!(pct_str == "Hello World!"); // => true
// The underlying string is unchanged.
assert!(pct_str.as_str() == "Hello%20World%21"); // => true
// 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);
}
// => Hello World!
println!("");
// 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);
// => Hello World!
Ok(())
}
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
fn main() -> pct_str::Result<()> {
// [`PctString`] is the equivalent of [`String`] for
// percent-encoded strings.
// The data is owned by `pct_string`.
let pct_string = PctString::new("Hello%20World%21")?;
// You can compare percent-encoded strings with a regular string.
assert!(pct_string == "Hello World!");
// The underlying string is percent-encoded.
assert!(pct_string.as_str() == "Hello%20World%21");
// You can get a reference to the string as a [`PctStr`].
assert!(pct_string.as_pct_str() == PctStr::new("Hello%20World%21")?);
// Just as a regular string, you can iterate over the
// encoded characters of `pct_str` with [`PctString::chars`].
for c in pct_string.chars() {
println!("{}", c);
}
// You can decode the string and every remove percent-encoded characters
// with the [`PctStr::decode`] method.
let decoded_string: String = pct_string.decode();
println!("{}", decoded_string);
Ok(())
}
sourcepub fn chars(&self) -> Chars<'_> ⓘ
pub fn chars(&self) -> Chars<'_> ⓘ
Iterate over the encoded characters of the string.
Examples found in repository?
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
fn main() -> pct_str::Result<()> {
// [`PctStr`] is the equivalent of [`str`] for percent-encoded strings.
let buffer = "Hello%20World%21";
// It is just a reference to `buffer`.
// It can fail if `buffer` is not a valid percent-encoded string.
let pct_str = PctStr::new(buffer)?;
// You can compare percent-encoded strings with a regular string.
assert!(pct_str == "Hello World!"); // => true
// The underlying string is unchanged.
assert!(pct_str.as_str() == "Hello%20World%21"); // => true
// 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);
}
// => Hello World!
println!("");
// 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);
// => Hello World!
Ok(())
}
More examples
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
fn main() -> pct_str::Result<()> {
// [`PctString`] is the equivalent of [`String`] for
// percent-encoded strings.
// The data is owned by `pct_string`.
let pct_string = PctString::new("Hello%20World%21")?;
// You can compare percent-encoded strings with a regular string.
assert!(pct_string == "Hello World!");
// The underlying string is percent-encoded.
assert!(pct_string.as_str() == "Hello%20World%21");
// You can get a reference to the string as a [`PctStr`].
assert!(pct_string.as_pct_str() == PctStr::new("Hello%20World%21")?);
// Just as a regular string, you can iterate over the
// encoded characters of `pct_str` with [`PctString::chars`].
for c in pct_string.chars() {
println!("{}", c);
}
// You can decode the string and every remove percent-encoded characters
// with the [`PctStr::decode`] method.
let decoded_string: String = pct_string.decode();
println!("{}", decoded_string);
Ok(())
}
sourcepub fn decode(&self) -> String
pub fn decode(&self) -> String
Decoding.
Return the string with the percent-encoded characters decoded.
Examples found in repository?
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
fn main() -> pct_str::Result<()> {
// [`PctStr`] is the equivalent of [`str`] for percent-encoded strings.
let buffer = "Hello%20World%21";
// It is just a reference to `buffer`.
// It can fail if `buffer` is not a valid percent-encoded string.
let pct_str = PctStr::new(buffer)?;
// You can compare percent-encoded strings with a regular string.
assert!(pct_str == "Hello World!"); // => true
// The underlying string is unchanged.
assert!(pct_str.as_str() == "Hello%20World%21"); // => true
// 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);
}
// => Hello World!
println!("");
// 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);
// => Hello World!
Ok(())
}
More examples
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
fn main() -> pct_str::Result<()> {
// [`PctString`] is the equivalent of [`String`] for
// percent-encoded strings.
// The data is owned by `pct_string`.
let pct_string = PctString::new("Hello%20World%21")?;
// You can compare percent-encoded strings with a regular string.
assert!(pct_string == "Hello World!");
// The underlying string is percent-encoded.
assert!(pct_string.as_str() == "Hello%20World%21");
// You can get a reference to the string as a [`PctStr`].
assert!(pct_string.as_pct_str() == PctStr::new("Hello%20World%21")?);
// Just as a regular string, you can iterate over the
// encoded characters of `pct_str` with [`PctString::chars`].
for c in pct_string.chars() {
println!("{}", c);
}
// You can decode the string and every remove percent-encoded characters
// with the [`PctStr::decode`] method.
let decoded_string: String = pct_string.decode();
println!("{}", decoded_string);
Ok(())
}
Trait Implementations§
source§impl PartialEq<PctStr> for PctStr
impl PartialEq<PctStr> for PctStr
source§impl PartialEq<PctStr> for PctString
impl PartialEq<PctStr> for PctString
source§impl PartialEq<PctString> for PctStr
impl PartialEq<PctString> for PctStr
source§impl PartialOrd<PctStr> for PctStr
impl PartialOrd<PctStr> for PctStr
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PartialOrd<PctStr> for PctString
impl PartialOrd<PctStr> for PctString
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PartialOrd<PctString> for PctStr
impl PartialOrd<PctString> for PctStr
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more