pct-str

Crates.iopct-str
lib.rspct-str
version2.0.0
sourcesrc
created_at2020-03-10 12:42:12.441892
updated_at2023-07-02 22:51:18.800999
descriptionPercent-encoded strings for URL, URI, IRI, etc.
homepage
repositoryhttps://github.com/timothee-haudebourg/pct-str
max_upload_size
id217246
size48,006
Timothée Haudebourg (timothee-haudebourg)

documentation

https://docs.rs/pct-str

README

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.

Commit count: 43

cargo fmt