src/libserialize/hex.rs

   1 // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Hex binary-to-text encoding
  12
  13 pub use self::FromHexError::*;
  14
  15 use std::fmt;
  16 use std::error;
  17
  18 /// A trait for converting a value to hexadecimal encoding
  19 pub trait ToHex {
  20     /// Converts the value of `self` to a hex value, returning the owned
  21     /// string.
  22     fn to_hex(&self) -> String;
  23 }
  24
  25 const CHARS: &'static [u8] = b"0123456789abcdef";
  26
  27 impl ToHex for [u8] {
  28     /// Turn a vector of `u8` bytes into a hexadecimal string.
  29     ///
  30     /// # Examples
  31     ///
  32     /// ```
  33     /// #![feature(rustc_private)]
  34     ///
  35     /// extern crate serialize;
  36     /// use serialize::hex::ToHex;
  37     ///
  38     /// fn main () {
  39     ///     let str = [52,32].to_hex();
  40     ///     println!("{}", str);
  41     /// }
  42     /// ```
  43     fn to_hex(&self) -> String {
  44         let mut v = Vec::with_capacity(self.len() * 2);
  45         for &byte in self {
  46             v.push(CHARS[(byte >> 4) as usize]);
  47             v.push(CHARS[(byte & 0xf) as usize]);
  48         }
  49
  50         unsafe {
  51             String::from_utf8_unchecked(v)
  52         }
  53     }
  54 }
  55
  56 /// A trait for converting hexadecimal encoded values
  57 pub trait FromHex {
  58     /// Converts the value of `self`, interpreted as hexadecimal encoded data,
  59     /// into an owned vector of bytes, returning the vector.
  60     fn from_hex(&self) -> Result<Vec<u8>, FromHexError>;
  61 }
  62
  63 /// Errors that can occur when decoding a hex encoded string
  64 #[derive(Copy, Clone, Debug)]
  65 pub enum FromHexError {
  66     /// The input contained a character not part of the hex format
  67     InvalidHexCharacter(char, usize),
  68     /// The input had an invalid length
  69     InvalidHexLength,
  70 }
  71
  72 impl fmt::Display for FromHexError {
  73     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  74         match *self {
  75             InvalidHexCharacter(ch, idx) =>
  76                 write!(f, "Invalid character '{}' at position {}", ch, idx),
  77             InvalidHexLength => write!(f, "Invalid input length"),
  78         }
  79     }
  80 }
  81
  82 impl error::Error for FromHexError {
  83     fn description(&self) -> &str {
  84         match *self {
  85             InvalidHexCharacter(_, _) => "invalid character",
  86             InvalidHexLength => "invalid length",
  87         }
  88     }
  89 }
  90
  91
  92 impl FromHex for str {
  93     /// Convert any hexadecimal encoded string (literal, `@`, `&`, or `~`)
  94     /// to the byte values it encodes.
  95     ///
  96     /// You can use the `String::from_utf8` function to turn a
  97     /// `Vec<u8>` into a string with characters corresponding to those values.
  98     ///
  99     /// # Examples
 100     ///
 101     /// This converts a string literal to hexadecimal and back.
 102     ///
 103     /// ```
 104     /// #![feature(rustc_private)]
 105     ///
 106     /// extern crate serialize;
 107     /// use serialize::hex::{FromHex, ToHex};
 108     ///
 109     /// fn main () {
 110     ///     let hello_str = "Hello, World".as_bytes().to_hex();
 111     ///     println!("{}", hello_str);
 112     ///     let bytes = hello_str.from_hex().unwrap();
 113     ///     println!("{:?}", bytes);
 114     ///     let result_str = String::from_utf8(bytes).unwrap();
 115     ///     println!("{}", result_str);
 116     /// }
 117     /// ```
 118     fn from_hex(&self) -> Result<Vec<u8>, FromHexError> {
 119         // This may be an overestimate if there is any whitespace
 120         let mut b = Vec::with_capacity(self.len() / 2);
 121         let mut modulus = 0;
 122         let mut buf = 0;
 123
 124         for (idx, byte) in self.bytes().enumerate() {
 125             buf <<= 4;
 126
 127             match byte {
 128                 b'A'...b'F' => buf |= byte - b'A' + 10,
 129                 b'a'...b'f' => buf |= byte - b'a' + 10,
 130                 b'0'...b'9' => buf |= byte - b'0',
 131                 b' '|b'\r'|b'\n'|b'\t' => {
 132                     buf >>= 4;
 133                     continue
 134                 }
 135                 _ => return Err(InvalidHexCharacter(self.char_at(idx), idx)),
 136             }
 137
 138             modulus += 1;
 139             if modulus == 2 {
 140                 modulus = 0;
 141                 b.push(buf);
 142             }
 143         }
 144
 145         match modulus {
 146             0 => Ok(b.into_iter().collect()),
 147             _ => Err(InvalidHexLength),
 148         }
 149     }
 150 }
 151
 152 #[cfg(test)]
 153 mod tests {
 154     extern crate test;
 155     use self::test::Bencher;
 156     use hex::{FromHex, ToHex};
 157
 158     #[test]
 159     pub fn test_to_hex() {
 160         assert_eq!("foobar".as_bytes().to_hex(), "666f6f626172");
 161     }
 162
 163     #[test]
 164     pub fn test_from_hex_okay() {
 165         assert_eq!("666f6f626172".from_hex().unwrap(),
 166                    b"foobar");
 167         assert_eq!("666F6F626172".from_hex().unwrap(),
 168                    b"foobar");
 169     }
 170
 171     #[test]
 172     pub fn test_from_hex_odd_len() {
 173         assert!("666".from_hex().is_err());
 174         assert!("66 6".from_hex().is_err());
 175     }
 176
 177     #[test]
 178     pub fn test_from_hex_invalid_char() {
 179         assert!("66y6".from_hex().is_err());
 180     }
 181
 182     #[test]
 183     pub fn test_from_hex_ignores_whitespace() {
 184         assert_eq!("666f 6f6\r\n26172 ".from_hex().unwrap(),
 185                    b"foobar");
 186     }
 187
 188     #[test]
 189     pub fn test_to_hex_all_bytes() {
 190         for i in 0..256 {
 191             assert_eq!([i as u8].to_hex(), format!("{:02x}", i as usize));
 192         }
 193     }
 194
 195     #[test]
 196     pub fn test_from_hex_all_bytes() {
 197         for i in 0..256 {
 198             let ii: &[u8] = &[i as u8];
 199             assert_eq!(format!("{:02x}", i as usize).from_hex()
 200                                                    .unwrap(),
 201                        ii);
 202             assert_eq!(format!("{:02X}", i as usize).from_hex()
 203                                                    .unwrap(),
 204                        ii);
 205         }
 206     }
 207
 208     #[bench]
 209     pub fn bench_to_hex(b: &mut Bencher) {
 210         let s = "イロハニホヘト チリヌルヲ ワカヨタレソ ツネナラム \
 211                  ウヰノオクヤマ ケフコエテ アサキユメミシ ヱヒモセスン";
 212         b.iter(|| {
 213             s.as_bytes().to_hex();
 214         });
 215         b.bytes = s.len() as u64;
 216     }
 217
 218     #[bench]
 219     pub fn bench_from_hex(b: &mut Bencher) {
 220         let s = "イロハニホヘト チリヌルヲ ワカヨタレソ ツネナラム \
 221                  ウヰノオクヤマ ケフコエテ アサキユメミシ ヱヒモセスン";
 222         let sb = s.as_bytes().to_hex();
 223         b.iter(|| {
 224             sb.from_hex().unwrap();
 225         });
 226         b.bytes = sb.len() as u64;
 227     }
 228 }