6 stable releases

2.0.0 Jul 2, 2023
1.2.0 Feb 2, 2023
1.1.0 Sep 10, 2020
1.0.2 Mar 16, 2020

#603 in Encoding

Download history 7052/week @ 2024-02-26 7342/week @ 2024-03-04 6542/week @ 2024-03-11 6949/week @ 2024-03-18 7102/week @ 2024-03-25 7592/week @ 2024-04-01 8269/week @ 2024-04-08 7386/week @ 2024-04-15 7922/week @ 2024-04-22 7333/week @ 2024-04-29 7850/week @ 2024-05-06 9150/week @ 2024-05-13 7754/week @ 2024-05-20 6951/week @ 2024-05-27 6788/week @ 2024-06-03 8648/week @ 2024-06-10

30,667 downloads per month
Used in 87 crates (9 directly)

MIT/Apache

29KB
684 lines

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.

use pct_str::PctStr;

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

let decoded_string: String = pct_str.decode();
assert_eq!(decoded_string, "Hello World!")

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

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);

assert_eq!(pct_string.as_str(), "Hello%20World%21");

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

use pct_str::{URIReserved, PctString};

struct CustomEncoder;

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

let pct_string = PctString::encode("Hello World!".chars(), CustomEncoder);
assert_eq!(pct_string.as_str(), "%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.

Dependencies

~285–740KB
~17K SLoC