diff --git a/Cargo.toml b/Cargo.toml index fbd41a9..607cc53 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "rustc-hex" -version = "1.0.0" -authors = ["The Rust Project Developers", "debris "] +version = "2.0.0" +authors = ["The Rust Project Developers", "debris ", "Robert Habermeier"] license = "MIT/Apache-2.0" repository = "https://github.com/debris/rustc-hex" homepage = "https://github.com/debris/rustc-hex" @@ -10,4 +10,8 @@ description = """ rustc-serialize compatible hex conversion traits """ +[features] +default = ["std"] +std = [] + [dependencies] diff --git a/src/lib.rs b/src/lib.rs index 3c7df19..9e4c403 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -7,24 +7,31 @@ // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. -// -// ignore-lexer-test FIXME #15679 //! Hex binary-to-text encoding -pub use self::FromHexError::*; +#![cfg_attr(not(feature = "std"), no_std)] + +#[cfg(feature = "std")] +extern crate core; +#[cfg(feature = "std")] use std::fmt; -use std::error; +#[cfg(not(feature = "std"))] +use core::fmt; + +use core::iter::{self, FromIterator}; + +pub use self::FromHexError::*; /// A trait for converting a value to hexadecimal encoding pub trait ToHex { - /// Converts the value of `self` to a hex value, returning the owned - /// string. - fn to_hex(&self) -> String; + /// Converts the value of `self` to a hex value, constructed from + /// an iterator of characaters. + fn to_hex>(&self) -> T; } -static CHARS: &'static[u8] = b"0123456789abcdef"; +static CHARS: &'static [u8] = b"0123456789abcdef"; impl ToHex for [u8] { /// Turn a vector of `u8` bytes into a hexadecimal string. @@ -32,29 +39,60 @@ impl ToHex for [u8] { /// # Example /// /// ```rust - /// extern crate rustc_serialize; - /// use rustc_serialize::hex::ToHex; + /// extern crate rustc_hex; + /// use rustc_hex::ToHex; /// /// fn main () { - /// let str = [52,32].to_hex(); + /// let str: String = [52,32].to_hex(); /// println!("{}", str); /// } /// ``` - fn to_hex(&self) -> String { - let mut v = Vec::with_capacity(self.len() * 2); - for &byte in self.iter() { - v.push(CHARS[(byte >> 4) as usize]); - v.push(CHARS[(byte & 0xf) as usize]); + fn to_hex>(&self) -> T { + struct SliceToHex<'a> { + live: Option, + inner: ::core::slice::Iter<'a, u8>, } - unsafe { - String::from_utf8_unchecked(v) + impl<'a> Iterator for SliceToHex<'a> { + type Item = char; + + fn next(&mut self) -> Option { + if let Some(live) = self.live.take() { + return Some(live); + } + + self.inner.next().map(|&byte| { + let current = CHARS[(byte >> 4) as usize] as char; + self.live = Some(CHARS[(byte & 0xf) as usize] as char); + current + }) + } + + fn size_hint(&self) -> (usize, Option) { + let len = self.len(); + (len, Some(len)) + } + } + + impl<'a> iter::ExactSizeIterator for SliceToHex<'a> { + fn len(&self) -> usize { + let mut len = self.inner.len() * 2; + if self.live.is_some() { + len += 1; + } + len + } } + + SliceToHex { + live: None, + inner: self.iter() + }.collect() } } impl<'a, T: ?Sized + ToHex> ToHex for &'a T { - fn to_hex(&self) -> String { + fn to_hex>(&self) -> U { (**self).to_hex() } } @@ -62,8 +100,8 @@ impl<'a, T: ?Sized + ToHex> ToHex for &'a T { /// A trait for converting hexadecimal encoded values pub trait FromHex { /// Converts the value of `self`, interpreted as hexadecimal encoded data, - /// into an owned vector of bytes, returning the vector. - fn from_hex(&self) -> Result, FromHexError>; + /// into an owned value constructed from an iterator of bytes. + fn from_hex>(&self) -> Result; } /// Errors that can occur when decoding a hex encoded string @@ -75,6 +113,7 @@ pub enum FromHexError { InvalidHexLength, } +#[cfg(feature = "std")] impl fmt::Debug for FromHexError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { @@ -85,7 +124,8 @@ impl fmt::Debug for FromHexError { } } -impl error::Error for FromHexError { +#[cfg(feature = "std")] +impl ::std::error::Error for FromHexError { fn description(&self) -> &str { match *self { InvalidHexCharacter(_, _) => "invalid character", @@ -94,12 +134,28 @@ impl error::Error for FromHexError { } } +#[cfg(feature = "std")] impl fmt::Display for FromHexError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(&self, f) } } +#[cfg(not(feature = "std"))] +impl fmt::Display for FromHexError { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + match *self { + InvalidHexCharacter(ch, idx) => { + f.write_str("invalid character: ")?; + ch.fmt(f)?; + f.write_str(" at index ")?; + idx.fmt(f) + } + InvalidHexLength => f.write_str("invalid length"), + } + } +} + impl FromHex for str { /// Convert any hexadecimal encoded string (literal, `@`, `&`, or `~`) /// to the byte values it encodes. @@ -112,99 +168,118 @@ impl FromHex for str { /// This converts a string literal to hexadecimal and back. /// /// ```rust - /// extern crate rustc_serialize; - /// use rustc_serialize::hex::{FromHex, ToHex}; + /// extern crate rustc_hex; + /// use rustc_hex::{FromHex, ToHex}; /// /// fn main () { - /// let hello_str = "Hello, World".as_bytes().to_hex(); + /// let hello_str: String = "Hello, World".as_bytes().to_hex(); /// println!("{}", hello_str); - /// let bytes = hello_str.from_hex().unwrap(); + /// let bytes: Vec = hello_str.from_hex().unwrap(); /// println!("{:?}", bytes); /// let result_str = String::from_utf8(bytes).unwrap(); /// println!("{}", result_str); /// } /// ``` - fn from_hex(&self) -> Result, FromHexError> { - // This may be an overestimate if there is any whitespace - let mut b = Vec::with_capacity(self.len() / 2); - let mut modulus = 0; - let mut buf = 0; - - for (idx, byte) in self.bytes().enumerate() { - buf <<= 4; - - match byte { - b'A'...b'F' => buf |= byte - b'A' + 10, - b'a'...b'f' => buf |= byte - b'a' + 10, - b'0'...b'9' => buf |= byte - b'0', - b' '|b'\r'|b'\n'|b'\t' => { - buf >>= 4; - continue + fn from_hex>(&self) -> Result { + struct StrFromHex<'a> { + err: &'a mut Result<(), FromHexError>, + inner: &'a str, + iter: iter::Enumerate<::core::str::Bytes<'a>>, + } + + impl<'a> Iterator for StrFromHex<'a> { + type Item = u8; + + fn next(&mut self) -> Option { + let mut modulus = 0; + let mut buf = 0; + for (idx, byte) in &mut self.iter { + buf <<= 4; + + match byte { + b'A'...b'F' => buf |= byte - b'A' + 10, + b'a'...b'f' => buf |= byte - b'a' + 10, + b'0'...b'9' => buf |= byte - b'0', + b' '|b'\r'|b'\n'|b'\t' => { + buf >>= 4; + continue + } + _ => { + let ch = self.inner[idx..].chars().next().unwrap(); + *self.err = Err(InvalidHexCharacter(ch, idx)); + return None; + } + } + + modulus += 1; + if modulus == 2 { + return Some(buf); + } } - _ => { - let ch = self[idx..].chars().next().unwrap(); - return Err(InvalidHexCharacter(ch, idx)) + + if modulus != 0 { + *self.err = Err(InvalidHexLength); } - } - modulus += 1; - if modulus == 2 { - modulus = 0; - b.push(buf); + None } } - match modulus { - 0 => Ok(b.into_iter().collect()), - _ => Err(InvalidHexLength), - } + let mut err = Ok(()); + let val: T = StrFromHex { + err: &mut err, + inner: self, + iter: self.bytes().enumerate(), + }.collect(); + + err.map(move |_| val) } } impl<'a, T: ?Sized + FromHex> FromHex for &'a T { - fn from_hex(&self) -> Result, FromHexError> { + fn from_hex>(&self) -> Result { (**self).from_hex() } } #[cfg(test)] mod tests { - use hex::{FromHex, ToHex}; + use super::{FromHex, ToHex}; #[test] pub fn test_to_hex() { - assert_eq!("foobar".as_bytes().to_hex(), "666f6f626172"); + assert_eq!("foobar".as_bytes().to_hex::(), "666f6f626172"); } #[test] pub fn test_from_hex_okay() { - assert_eq!("666f6f626172".from_hex().unwrap(), + assert_eq!("666f6f626172".from_hex::>().unwrap(), b"foobar"); - assert_eq!("666F6F626172".from_hex().unwrap(), + assert_eq!("666F6F626172".from_hex::>().unwrap(), b"foobar"); } #[test] pub fn test_from_hex_odd_len() { - assert!("666".from_hex().is_err()); - assert!("66 6".from_hex().is_err()); + assert!("666".from_hex::>().is_err()); + assert!("66 6".from_hex::>().is_err()); } #[test] pub fn test_from_hex_invalid_char() { - assert!("66y6".from_hex().is_err()); + assert!("66y6".from_hex::>().is_err()); } #[test] pub fn test_from_hex_ignores_whitespace() { - assert_eq!("666f 6f6\r\n26172 ".from_hex().unwrap(), + assert_eq!("666f 6f6\r\n26172 ".from_hex::>().unwrap(), b"foobar"); } #[test] pub fn test_to_hex_all_bytes() { for i in 0..256 { - assert_eq!([i as u8].to_hex(), format!("{:02x}", i)); + assert_eq!([i as u8].to_hex::(), format!("{:02x}", i)); } } @@ -212,9 +287,9 @@ mod tests { pub fn test_from_hex_all_bytes() { for i in 0..256 { let ii: &[u8] = &[i as u8]; - assert_eq!(format!("{:02x}", i).from_hex().unwrap(), + assert_eq!(format!("{:02x}", i).from_hex::>().unwrap(), ii); - assert_eq!(format!("{:02X}", i).from_hex().unwrap(), + assert_eq!(format!("{:02X}", i).from_hex::>().unwrap(), ii); } }