-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,34 @@ | ||
# urlencoding | ||
|
||
[![Latest Version](https://img.shields.io/crates/v/urlencoding.svg)](https://crates.io/crates/urlencoding) | ||
|
||
A Rust library for doing URL percentage encoding. | ||
|
||
Installation | ||
============ | ||
|
||
This crate can be downloaded through Cargo. To do so, add the following line to your `Cargo.toml` file, under `dependencies`: | ||
|
||
```toml | ||
urlencoding = "0.1" | ||
``` | ||
|
||
Usage | ||
===== | ||
|
||
To encode a string, do the following: | ||
|
||
```rust | ||
extern crate urlencoding; | ||
|
||
use urlencoding::UrlEncoder; | ||
|
||
fn main() { | ||
let encoder = UrlEncoder::new(); | ||
|
||
let encoded = encoder.encode("This string will be URL encoded."); | ||
// This%20string%20will%20be%20URL%20encoded. | ||
} | ||
``` | ||
|
||
Decoding is pending implementation. |