diff options
| author | Trinity Pointard <trinity.pointard@gmail.com> | 2021-03-26 22:32:09 +0100 |
|---|---|---|
| committer | Alex Auvolat <alex@adnab.me> | 2021-04-27 16:37:10 +0200 |
| commit | 1e3df189d0dc37880219338c53607152ae0c87e0 (patch) | |
| tree | db1a0ccea1b29c8916ed3246ff71ea66b3323bac /src/api/encoding.rs | |
| parent | a2e1617d845e72c44b07f782801549f209ce14cc (diff) | |
| download | garage-1e3df189d0dc37880219338c53607152ae0c87e0.tar.gz garage-1e3df189d0dc37880219338c53607152ae0c87e0.zip | |
document api crate
Diffstat (limited to 'src/api/encoding.rs')
| -rw-r--r-- | src/api/encoding.rs | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/api/encoding.rs b/src/api/encoding.rs index 25999207..63c5dee2 100644 --- a/src/api/encoding.rs +++ b/src/api/encoding.rs @@ -1,9 +1,13 @@ +//! Module containing various helpers for encoding + +/// Escape &str for xml inclusion pub fn xml_escape(s: &str) -> String { s.replace("<", "<") .replace(">", ">") .replace("\"", """) } +/// Encode &str for use in a URI pub fn uri_encode(string: &str, encode_slash: bool) -> String { let mut result = String::with_capacity(string.len() * 2); for c in string.chars() { @@ -24,6 +28,7 @@ pub fn uri_encode(string: &str, encode_slash: bool) -> String { result } +/// Encode &str either as an uri, or a valid string for xml inclusion pub fn xml_encode_key(k: &str, urlencode: bool) -> String { if urlencode { uri_encode(k, true) |