From be7530e0faf3bfd402ed4eae5edf4ebb98dd3ef9 Mon Sep 17 00:00:00 2001 From: "Craig M. Brandenburg" Date: Sat, 26 Dec 2015 06:24:11 -0700 Subject: [PATCH] Add doc comment for percent_encoding::from_hex --- src/percent_encoding.rs | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/percent_encoding.rs b/src/percent_encoding.rs index 146bede2..ee11cc3d 100644 --- a/src/percent_encoding.rs +++ b/src/percent_encoding.rs @@ -138,6 +138,24 @@ pub fn lossy_utf8_percent_decode(input: &[u8]) -> String { String::from_utf8_lossy(&percent_decode(input)).to_string() } +/// Convert the given hex character into its numeric value. +/// +/// # Examples +/// +/// ``` +/// use url::percent_encoding::from_hex; +/// assert_eq!(from_hex('0' as u8), Some(0)); +/// assert_eq!(from_hex('1' as u8), Some(1)); +/// assert_eq!(from_hex('9' as u8), Some(9)); +/// assert_eq!(from_hex('A' as u8), Some(10)); +/// assert_eq!(from_hex('a' as u8), Some(10)); +/// assert_eq!(from_hex('F' as u8), Some(15)); +/// assert_eq!(from_hex('f' as u8), Some(15)); +/// assert_eq!(from_hex('G' as u8), None); +/// assert_eq!(from_hex('g' as u8), None); +/// assert_eq!(from_hex('Z' as u8), None); +/// assert_eq!(from_hex('z' as u8), None); +/// ``` #[inline] pub fn from_hex(byte: u8) -> Option { match byte {