Percent-Encoded Strings for Rust

Build Crate informations License Documentation

This crate provides two types, [PctStr] and [PctString], similar to [str] and [String], representing percent-encoded strings used in URL, URI, IRI, etc. You can use them to encode, decode and compare percent-encoded strings.

Basic usage

You can parse/decode percent-encoded strings by building a [PctStr] slice over a [str] slice.

```rust use pct_str::PctStr;

let pctstr = PctStr::new("Hello%20World%21").unwrap(); asserteq!(pct_str, "Hello World!");

let decodedstring: String = pctstr.decode(); asserteq!(decodedstring, "Hello World!") ```

To create new percent-encoded strings, use the [PctString] to copy or encode new strings.

```rust use pct_str::{PctString, URIReserved};

// Copy the given percent-encoded string. let pct_string = PctString::new("Hello%20World%21").unwrap();

// Encode the given regular string. let pct_string = PctString::encode("Hello World!".chars(), URIReserved);

asserteq!(pctstring.as_str(), "Hello%20World%21"); ```

You can choose which character will be percent-encoded by the encode function by implementing the [Encoder] trait.

```rust use pct_str::{URIReserved, PctString};

struct CustomEncoder;

impl pctstr::Encoder for CustomEncoder { fn encode(&self, c: char) -> bool { URIReserved.encode(c) || c.isuppercase() } }

let pctstring = PctString::encode("Hello World!".chars(), CustomEncoder); asserteq!(pctstring.asstr(), "%48ello%20%57orld%21") ```

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.