//! Unified interfaces for bytes operations on basic types //! //! # Examples //! ```rust //! extern crate ethcore_util as util; //! //! fn bytes_convertable() { //! use util::bytes::BytesConvertable; //! //! let arr = [0; 5]; //! let slice: &[u8] = arr.bytes(); //! } //! //! fn to_bytes() { //! use util::bytes::ToBytes; //! //! let a: Vec = "hello_world".to_bytes(); //! let b: Vec = 400u32.to_bytes(); //! let c: Vec = 0xffffffffffffffffu64.to_bytes(); //! } //! //! fn from_bytes() { //! use util::bytes::FromBytes; //! //! let a = String::from_bytes(&[b'd', b'o', b'g']); //! let b = u16::from_bytes(&[0xfa]); //! let c = u64::from_bytes(&[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff]); //! } //! //! fn main() { //! bytes_convertable(); //! to_bytes(); //! from_bytes(); //! } //! ``` use std::fmt; use std::cmp::Ordering; use std::error::Error as StdError; use uint::{U128, U256}; use hash::FixedHash; pub struct PrettySlice<'a> (&'a [u8]); impl<'a> fmt::Debug for PrettySlice<'a> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { for i in 0..self.0.len() { try!(write!(f, "{:02x}", self.0[i])); } Ok(()) } } pub trait ToPretty { fn pretty(&self) -> PrettySlice; } impl<'a> ToPretty for &'a [u8] { fn pretty(&self) -> PrettySlice { PrettySlice(self) } } impl<'a> ToPretty for &'a Bytes { fn pretty(&self) -> PrettySlice { PrettySlice(self.bytes()) } } impl ToPretty for Bytes { fn pretty(&self) -> PrettySlice { PrettySlice(self.bytes()) } } /// Vector of bytes pub type Bytes = Vec; /// Slice of bytes to underlying memory pub trait BytesConvertable { fn bytes(&self) -> &[u8]; } impl<'a> BytesConvertable for &'a [u8] { fn bytes(&self) -> &[u8] { self } } impl BytesConvertable for Vec { fn bytes(&self) -> &[u8] { self } } macro_rules! impl_bytes_convertable_for_array { ($zero: expr) => (); ($len: expr, $($idx: expr),*) => { impl BytesConvertable for [u8; $len] { fn bytes(&self) -> &[u8] { self } } impl_bytes_convertable_for_array! { $($idx),* } } } // -1 at the end is not expanded impl_bytes_convertable_for_array! { 32, 31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0, -1 } #[test] fn bytes_convertable() { assert_eq!(vec![0x12u8, 0x34].bytes(), &[0x12u8, 0x34]); assert_eq!([0u8; 0].bytes(), &[]); } /// Converts given type to its shortest representation in bytes /// /// TODO: optimise some conversations pub trait ToBytes { fn to_bytes(&self) -> Vec; fn to_bytes_len(&self) -> usize { self.to_bytes().len() } fn first_byte(&self) -> Option { self.to_bytes().first().map(|&x| { x })} } impl <'a> ToBytes for &'a str { fn to_bytes(&self) -> Vec { From::from(*self) } fn to_bytes_len(&self) -> usize { self.len() } } impl ToBytes for String { fn to_bytes(&self) -> Vec { let s: &str = self.as_ref(); From::from(s) } fn to_bytes_len(&self) -> usize { self.len() } } impl ToBytes for u64 { fn to_bytes(&self) -> Vec { let mut res= vec![]; let count = self.to_bytes_len(); res.reserve(count); for i in 0..count { let j = count - 1 - i; res.push((*self >> (j * 8)) as u8); } res } fn to_bytes_len(&self) -> usize { 8 - self.leading_zeros() as usize / 8 } } macro_rules! impl_map_to_bytes { ($from: ident, $to: ty) => { impl ToBytes for $from { fn to_bytes(&self) -> Vec { (*self as $to).to_bytes() } fn to_bytes_len(&self) -> usize { (*self as $to).to_bytes_len() } } } } impl_map_to_bytes!(usize, u64); impl_map_to_bytes!(u16, u64); impl_map_to_bytes!(u32, u64); macro_rules! impl_uint_to_bytes { ($name: ident) => { impl ToBytes for $name { fn to_bytes(&self) -> Vec { let mut res= vec![]; let count = self.to_bytes_len(); res.reserve(count); for i in 0..count { let j = count - 1 - i; res.push(self.byte(j)); } res } fn to_bytes_len(&self) -> usize { (self.bits() + 7) / 8 } } } } impl_uint_to_bytes!(U256); impl_uint_to_bytes!(U128); impl ToBytes for T where T: FixedHash { fn to_bytes(&self) -> Vec { let mut res: Vec = vec![]; res.reserve(T::size()); unsafe { use std::ptr; ptr::copy(self.bytes().as_ptr(), res.as_mut_ptr(), T::size()); res.set_len(T::size()); } res } } /// Error returned when FromBytes conversation goes wrong #[derive(Debug, PartialEq, Eq)] pub enum FromBytesError { DataIsTooShort, DataIsTooLong } impl StdError for FromBytesError { fn description(&self) -> &str { "from_bytes error" } } impl fmt::Display for FromBytesError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(&self, f) } } /// Alias for the result of FromBytes trait pub type FromBytesResult = Result; /// Converts to given type from its bytes representation /// /// TODO: check size of bytes before conversation and return appropriate error pub trait FromBytes: Sized { fn from_bytes(bytes: &[u8]) -> FromBytesResult; } impl FromBytes for String { fn from_bytes(bytes: &[u8]) -> FromBytesResult { Ok(::std::str::from_utf8(bytes).unwrap().to_string()) } } impl FromBytes for u64 { fn from_bytes(bytes: &[u8]) -> FromBytesResult { match bytes.len() { 0 => Ok(0), l => { let mut res = 0u64; for i in 0..l { let shift = (l - 1 - i) * 8; res = res + ((bytes[i] as u64) << shift); } Ok(res) } } } } macro_rules! impl_map_from_bytes { ($from: ident, $to: ident) => { impl FromBytes for $from { fn from_bytes(bytes: &[u8]) -> FromBytesResult<$from> { $to::from_bytes(bytes).map(| x | { x as $from }) } } } } impl_map_from_bytes!(usize, u64); impl_map_from_bytes!(u16, u64); impl_map_from_bytes!(u32, u64); macro_rules! impl_uint_from_bytes { ($name: ident) => { impl FromBytes for $name { fn from_bytes(bytes: &[u8]) -> FromBytesResult<$name> { Ok($name::from(bytes)) } } } } impl_uint_from_bytes!(U256); impl_uint_from_bytes!(U128); impl FromBytes for T where T: FixedHash { fn from_bytes(bytes: &[u8]) -> FromBytesResult { match bytes.len().cmp(&T::size()) { Ordering::Less => return Err(FromBytesError::DataIsTooShort), Ordering::Greater => return Err(FromBytesError::DataIsTooLong), Ordering::Equal => () }; unsafe { use std::{mem, ptr}; let mut res: T = mem::uninitialized(); ptr::copy(bytes.as_ptr(), res.mut_bytes().as_mut_ptr(), T::size()); Ok(res) } } }