openethereum/ipc/rpc/src/binary.rs

1196 lines
31 KiB
Rust
Raw Normal View History

// Copyright 2015, 2016 Parity Technologies (UK) Ltd.
2016-04-20 13:17:11 +02:00
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
//! Binary representation of types
2016-11-16 13:37:21 +01:00
use util::{U256, U512, H256, H512, H2048, Address};
2016-04-20 18:01:53 +02:00
use std::mem;
use std::collections::{VecDeque, BTreeMap};
use std::ops::Range;
2016-07-12 10:33:20 +02:00
use super::Handshake;
2016-04-20 18:01:53 +02:00
2016-04-21 21:18:13 +02:00
#[derive(Debug)]
pub enum BinaryConvertErrorKind {
SizeMismatch {
expected: usize,
found: usize,
},
TargetPayloadEmpty,
UnexpectedVariant(u8),
MissingLengthValue,
InconsistentBoundaries,
NotSupported,
}
#[derive(Debug)]
pub struct BinaryConvertError {
member_tree: Vec<&'static str>,
kind: BinaryConvertErrorKind,
}
impl BinaryConvertError {
pub fn size(expected: usize, found: usize) -> BinaryConvertError {
BinaryConvertError {
member_tree: Vec::new(),
kind: BinaryConvertErrorKind::SizeMismatch {
expected: expected,
found: found,
}
}
}
pub fn empty() -> BinaryConvertError {
BinaryConvertError { member_tree: Vec::new(), kind: BinaryConvertErrorKind::TargetPayloadEmpty }
}
pub fn variant(val: u8) -> BinaryConvertError {
BinaryConvertError { member_tree: Vec::new(), kind: BinaryConvertErrorKind::UnexpectedVariant(val) }
}
pub fn length() -> BinaryConvertError {
BinaryConvertError { member_tree: Vec::new(), kind: BinaryConvertErrorKind::MissingLengthValue }
}
pub fn boundaries() -> BinaryConvertError {
BinaryConvertError { member_tree: Vec::new(), kind: BinaryConvertErrorKind::InconsistentBoundaries }
}
pub fn not_supported() -> BinaryConvertError {
BinaryConvertError { member_tree: Vec::new(), kind: BinaryConvertErrorKind::NotSupported }
}
pub fn named(mut self, name: &'static str) -> BinaryConvertError {
self.member_tree.push(name);
self
}
}
#[derive(Debug)]
pub enum BinaryError {
Serialization(BinaryConvertError),
Io(::std::io::Error),
}
impl From<::std::io::Error> for BinaryError {
fn from(err: ::std::io::Error) -> Self { BinaryError::Io(err) }
}
impl From<BinaryConvertError> for BinaryError {
fn from(err: BinaryConvertError) -> Self { BinaryError::Serialization(err) }
}
2016-04-20 13:17:11 +02:00
2016-04-20 17:02:17 +02:00
pub trait BinaryConvertable : Sized {
2016-04-21 21:18:13 +02:00
fn size(&self) -> usize {
mem::size_of::<Self>()
}
2016-04-20 13:17:11 +02:00
2016-04-21 21:18:13 +02:00
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError>;
2016-04-20 17:02:17 +02:00
2016-04-21 21:18:13 +02:00
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError>;
2016-04-20 19:22:24 +02:00
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Err(BinaryConvertError::size(mem::size_of::<Self>(), 0))
2016-04-20 19:22:24 +02:00
}
fn len_params() -> usize {
0
}
}
impl<T> BinaryConvertable for Option<T> where T: BinaryConvertable {
fn size(&self) -> usize {
match * self { None => 0, Some(ref val) => val.size() }
}
2016-04-21 21:18:13 +02:00
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
match *self { None => Err(BinaryConvertError::empty()), Some(ref val) => val.to_bytes(buffer, length_stack) }
2016-04-20 19:22:24 +02:00
}
2016-04-21 21:18:13 +02:00
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
if buffer.len() == 0 { return Self::from_empty_bytes(); }
2016-04-21 21:18:13 +02:00
Ok(Some(try!(T::from_bytes(buffer, length_stack))))
2016-04-20 19:22:24 +02:00
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(None)
}
fn len_params() -> usize {
1
}
}
2016-04-22 18:45:09 +02:00
impl<E: BinaryConvertable> BinaryConvertable for Result<(), E> {
fn size(&self) -> usize {
match *self {
2016-04-23 17:15:50 +02:00
Ok(_) => 0,
2016-04-22 18:45:09 +02:00
Err(ref e) => e.size(),
}
}
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
match *self {
Ok(_) => Err(BinaryConvertError::empty()),
2016-04-22 18:45:09 +02:00
Err(ref e) => Ok(try!(e.to_bytes(buffer, length_stack))),
}
}
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
Ok(Err(try!(E::from_bytes(&buffer, length_stack))))
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(Ok(()))
2016-04-22 18:45:09 +02:00
}
fn len_params() -> usize {
1
}
}
impl<R: BinaryConvertable> BinaryConvertable for Result<R, ()> {
fn size(&self) -> usize {
match *self {
Ok(ref r) => r.size(),
Err(_) => 0,
}
}
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
match *self {
Ok(ref r) => Ok(try!(r.to_bytes(buffer, length_stack))),
Err(_) => Err(BinaryConvertError::empty()),
}
}
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
Ok(Ok(try!(R::from_bytes(&buffer, length_stack))))
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(Err(()))
}
fn len_params() -> usize {
1
}
}
2016-04-22 18:45:09 +02:00
impl<R: BinaryConvertable, E: BinaryConvertable> BinaryConvertable for Result<R, E> {
fn size(&self) -> usize {
1usize + match *self {
Ok(ref r) => r.size(),
Err(ref e) => e.size(),
}
}
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
match *self {
Ok(ref r) => {
buffer[0] = 0;
if r.size() > 0 {
Ok(try!(r.to_bytes(&mut buffer[1..], length_stack)))
}
else { Ok(()) }
},
Err(ref e) => {
buffer[0] = 1;
if e.size() > 0 {
Ok(try!(e.to_bytes(&mut buffer[1..], length_stack)))
}
else { Ok(()) }
},
2016-04-22 18:45:09 +02:00
}
}
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
match buffer[0] {
0 => {
match buffer.len() {
1 => Ok(Ok(try!(R::from_empty_bytes()))),
_ => Ok(Ok(try!(R::from_bytes(&buffer[1..], length_stack)))),
}
}
2016-04-22 18:45:09 +02:00
1 => Ok(Err(try!(E::from_bytes(&buffer[1..], length_stack)))),
_ => Err(BinaryConvertError::variant(buffer[0]))
2016-04-22 18:45:09 +02:00
}
}
fn len_params() -> usize {
1
}
}
impl<K, V> BinaryConvertable for BTreeMap<K, V> where K : BinaryConvertable + Ord, V: BinaryConvertable {
fn size(&self) -> usize {
0usize + match K::len_params() {
0 => mem::size_of::<K>() * self.len(),
_ => self.iter().fold(0usize, |acc, (k, _)| acc + k.size())
} + match V::len_params() {
0 => mem::size_of::<V>() * self.len(),
_ => self.iter().fold(0usize, |acc, (_, v)| acc + v.size())
}
}
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
let mut offset = 0usize;
for (key, val) in self.iter() {
let key_size = match K::len_params() {
0 => mem::size_of::<K>(),
_ => { let size = key.size(); length_stack.push_back(size); size }
};
let val_size = match K::len_params() {
0 => mem::size_of::<V>(),
_ => { let size = val.size(); length_stack.push_back(size); size }
};
if key_size > 0 {
let item_end = offset + key_size;
try!(key.to_bytes(&mut buffer[offset..item_end], length_stack));
offset = item_end;
}
if val_size > 0 {
let item_end = offset + key_size;
try!(val.to_bytes(&mut buffer[offset..item_end], length_stack));
offset = item_end;
}
}
Ok(())
}
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
let mut index = 0;
let mut result = Self::new();
if buffer.len() == 0 { return Ok(result); }
loop {
let key_size = match K::len_params() {
0 => mem::size_of::<K>(),
_ => try!(length_stack.pop_front().ok_or(BinaryConvertError::length())),
};
let key = if key_size == 0 {
try!(K::from_empty_bytes())
} else {
if index + key_size > buffer.len() {
return Err(BinaryConvertError::boundaries())
}
try!(K::from_bytes(&buffer[index..index+key_size], length_stack))
};
index = index + key_size;
let val_size = match V::len_params() {
0 => mem::size_of::<V>(),
_ => try!(length_stack.pop_front().ok_or(BinaryConvertError::length())),
};
let val = if val_size == 0 {
try!(V::from_empty_bytes())
} else {
if index + val_size > buffer.len() {
return Err(BinaryConvertError::boundaries())
}
try!(V::from_bytes(&buffer[index..index+val_size], length_stack))
};
result.insert(key, val);
index = index + val_size;
if index == buffer.len() { break; }
if index > buffer.len() {
return Err(BinaryConvertError::boundaries())
}
}
Ok(result)
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(Self::new())
}
fn len_params() -> usize {
1
}
}
impl<T> BinaryConvertable for VecDeque<T> where T: BinaryConvertable {
fn size(&self) -> usize {
match T::len_params() {
0 => mem::size_of::<T>() * self.len(),
_ => self.iter().fold(0usize, |acc, t| acc + t.size()),
}
}
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
let mut offset = 0usize;
for item in self.iter() {
let next_size = match T::len_params() {
0 => mem::size_of::<T>(),
_ => { let size = item.size(); length_stack.push_back(size); size },
};
if next_size > 0 {
let item_end = offset + next_size;
try!(item.to_bytes(&mut buffer[offset..item_end], length_stack));
offset = item_end;
}
}
Ok(())
}
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
let mut index = 0;
let mut result = Self::with_capacity(
match T::len_params() {
0 => buffer.len() / mem::size_of::<T>(),
_ => 128,
});
if buffer.len() == 0 { return Ok(result); }
loop {
let next_size = match T::len_params() {
0 => mem::size_of::<T>(),
_ => try!(length_stack.pop_front().ok_or(BinaryConvertError::length())),
};
let item = if next_size == 0 {
try!(T::from_empty_bytes())
}
else {
if index + next_size > buffer.len() {
return Err(BinaryConvertError::boundaries())
}
try!(T::from_bytes(&buffer[index..index+next_size], length_stack))
};
result.push_back(item);
index = index + next_size;
if index == buffer.len() { break; }
if index > buffer.len() {
return Err(BinaryConvertError::boundaries())
}
}
Ok(result)
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(Self::new())
}
fn len_params() -> usize {
1
}
}
2016-04-20 19:22:24 +02:00
impl<T> BinaryConvertable for Vec<T> where T: BinaryConvertable {
fn size(&self) -> usize {
match T::len_params() {
0 => mem::size_of::<T>() * self.len(),
_ => self.iter().fold(0usize, |acc, t| acc + t.size()),
}
}
2016-04-21 21:18:13 +02:00
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
2016-04-20 19:22:24 +02:00
let mut offset = 0usize;
2016-04-21 21:18:13 +02:00
for item in self.iter() {
let next_size = match T::len_params() {
0 => mem::size_of::<T>(),
_ => { let size = item.size(); length_stack.push_back(size); size },
};
if next_size > 0 {
let item_end = offset + next_size;
try!(item.to_bytes(&mut buffer[offset..item_end], length_stack));
offset = item_end;
}
2016-04-20 19:22:24 +02:00
}
Ok(())
}
2016-04-21 21:18:13 +02:00
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
let mut index = 0;
let mut result = Self::with_capacity(
match T::len_params() {
0 => buffer.len() / mem::size_of::<T>(),
_ => 128,
});
if buffer.len() == 0 { return Ok(result); }
2016-04-21 21:18:13 +02:00
loop {
let next_size = match T::len_params() {
0 => mem::size_of::<T>(),
_ => try!(length_stack.pop_front().ok_or(BinaryConvertError::length())),
2016-04-21 21:18:13 +02:00
};
let item = if next_size == 0 {
try!(T::from_empty_bytes())
}
else {
if index + next_size > buffer.len() {
return Err(BinaryConvertError::boundaries())
}
2016-04-21 21:18:13 +02:00
try!(T::from_bytes(&buffer[index..index+next_size], length_stack))
};
result.push(item);
index = index + next_size;
if index == buffer.len() { break; }
if index > buffer.len() {
return Err(BinaryConvertError::boundaries())
2016-04-21 21:18:13 +02:00
}
}
Ok(result)
2016-04-20 19:22:24 +02:00
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(Self::new())
}
fn len_params() -> usize {
1
}
2016-04-20 13:17:11 +02:00
}
2016-04-20 18:01:53 +02:00
2016-04-22 18:45:09 +02:00
impl BinaryConvertable for String {
fn size(&self) -> usize {
self.as_bytes().len()
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(String::new())
}
fn to_bytes(&self, buffer: &mut [u8], _length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
buffer[..].clone_from_slice(self.as_bytes());
Ok(())
}
fn from_bytes(buffer: &[u8], _length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
Ok(::std::str::from_utf8(buffer).unwrap().to_owned())
}
fn len_params() -> usize {
1
}
}
impl<T> BinaryConvertable for Range<T> where T: BinaryConvertable {
fn size(&self) -> usize {
mem::size_of::<T>() * 2
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Err(BinaryConvertError::empty())
}
fn to_bytes(&self, buffer: &mut[u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
try!(self.start.to_bytes(&mut buffer[..mem::size_of::<T>()], length_stack));
try!(self.end.to_bytes(&mut buffer[mem::size_of::<T>() + 1..], length_stack));
Ok(())
}
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
Ok(try!(T::from_bytes(&buffer[..mem::size_of::<T>()], length_stack))..try!(T::from_bytes(&buffer[mem::size_of::<T>()+1..], length_stack)))
}
fn len_params() -> usize {
assert_eq!(0, T::len_params());
0
}
}
2016-04-25 16:20:38 +02:00
impl<T> BinaryConvertable for ::std::cell::RefCell<T> where T: BinaryConvertable {
fn size(&self) -> usize {
self.borrow().size()
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(::std::cell::RefCell::new(try!(T::from_empty_bytes())))
}
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
Ok(::std::cell::RefCell::new(try!(T::from_bytes(buffer, length_stack))))
}
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
try!(self.borrow().to_bytes(buffer, length_stack));
Ok(())
}
fn len_params() -> usize {
T::len_params()
}
}
impl<T> BinaryConvertable for ::std::cell::Cell<T> where T: BinaryConvertable + Copy {
fn size(&self) -> usize {
self.get().size()
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(::std::cell::Cell::new(try!(T::from_empty_bytes())))
}
fn from_bytes(buffer: &[u8], length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
Ok(::std::cell::Cell::new(try!(T::from_bytes(buffer, length_stack))))
}
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
try!(self.get().to_bytes(buffer, length_stack));
Ok(())
}
fn len_params() -> usize {
T::len_params()
}
}
2016-04-22 18:45:09 +02:00
impl BinaryConvertable for Vec<u8> {
fn size(&self) -> usize {
self.len()
}
fn from_empty_bytes() -> Result<Self, BinaryConvertError> {
Ok(Vec::new())
}
fn to_bytes(&self, buffer: &mut [u8], _length_stack: &mut VecDeque<usize>) -> Result<(), BinaryConvertError> {
buffer[..].clone_from_slice(&self[..]);
Ok(())
}
fn from_bytes(buffer: &[u8], _length_stack: &mut VecDeque<usize>) -> Result<Self, BinaryConvertError> {
let mut res = Self::with_capacity(buffer.len());
unsafe { res.set_len(buffer.len()) }
res[..].clone_from_slice(&buffer[..]);
Ok(res)
}
fn len_params() -> usize {
1
}
}
pub fn deserialize_from<T, R>(r: &mut R) -> Result<T, BinaryError>
2016-04-21 21:18:13 +02:00
where R: ::std::io::Read,
T: BinaryConvertable
{
let mut fake_stack = VecDeque::new();
2016-04-23 17:15:50 +02:00
match T::len_params() {
0 => {
let fixed_size = mem::size_of::<T>();
let mut payload_buffer = Vec::with_capacity(fixed_size);
unsafe { payload_buffer.set_len(fixed_size); }
let bytes_read = try!(r.read(&mut payload_buffer));
if bytes_read != mem::size_of::<T>() {
return Err(BinaryError::Serialization(BinaryConvertError::size(fixed_size, bytes_read)))
}
Ok(try!(T::from_bytes(&payload_buffer[..], &mut fake_stack)))
2016-04-23 17:15:50 +02:00
},
_ => {
let mut payload = Vec::new();
try!(r.read_to_end(&mut payload));
let stack_len = try!(u64::from_bytes(&payload[0..8], &mut fake_stack)) as usize;
let mut length_stack = VecDeque::<usize>::with_capacity(stack_len);
2016-04-23 17:15:50 +02:00
if stack_len > 0 {
2016-04-23 17:15:50 +02:00
for idx in 0..stack_len {
let stack_item = try!(u64::from_bytes(&payload[8 + idx*8..8 + (idx+1)*8], &mut fake_stack));
2016-04-23 17:15:50 +02:00
length_stack.push_back(stack_item as usize);
}
}
//try!(r.read(&mut size_buffer).map_err(|_| BinaryConvertError));
let size = try!(u64::from_bytes(&payload[8+stack_len*8..16+stack_len*8], &mut fake_stack)) as usize;
match size {
0 => {
Ok(try!(T::from_empty_bytes()))
},
_ => {
Ok(try!(T::from_bytes(&payload[16+stack_len*8..], &mut length_stack)))
}
}
2016-04-25 01:43:21 +02:00
},
2016-04-23 17:15:50 +02:00
}
2016-04-21 21:18:13 +02:00
}
pub fn deserialize<T: BinaryConvertable>(buffer: &[u8]) -> Result<T, BinaryError> {
2016-04-22 18:45:09 +02:00
use std::io::Cursor;
let mut buff = Cursor::new(buffer);
deserialize_from::<T, _>(&mut buff)
}
pub fn serialize_into<T, W>(t: &T, w: &mut W) -> Result<(), BinaryError>
2016-04-21 21:18:13 +02:00
where W: ::std::io::Write,
T: BinaryConvertable
{
let mut fake_stack = VecDeque::new();
2016-04-23 17:15:50 +02:00
match T::len_params() {
0 => {
let fixed_size = mem::size_of::<T>();
let mut buffer = Vec::with_capacity(fixed_size);
unsafe { buffer.set_len(fixed_size); }
try!(t.to_bytes(&mut buffer[..], &mut fake_stack));
try!(w.write(&buffer[..]));
2016-04-23 17:15:50 +02:00
Ok(())
},
_ => {
let mut length_stack = VecDeque::<usize>::new();
let mut size_buffer = [0u8; 8];
let size = t.size();
if size == 0 {
try!(w.write(&size_buffer));
try!(w.write(&size_buffer));
return Ok(());
}
2016-04-23 17:15:50 +02:00
let mut buffer = Vec::with_capacity(size);
unsafe { buffer.set_len(size); }
try!(t.to_bytes(&mut buffer[..], &mut length_stack));
let stack_len = length_stack.len();
try!((stack_len as u64).to_bytes(&mut size_buffer[..], &mut fake_stack));
try!(w.write(&size_buffer[..]));
2016-04-23 17:15:50 +02:00
if stack_len > 0 {
let mut header_buffer = Vec::with_capacity(stack_len * 8);
unsafe { header_buffer.set_len(stack_len * 8); };
try!((stack_len as u64).to_bytes(&mut header_buffer[0..8], &mut fake_stack));
let mut idx = 0;
loop {
match length_stack.pop_front() {
Some(val) => try!((val as u64).to_bytes(&mut header_buffer[idx * 8..(idx+1) * 8], &mut fake_stack)),
None => { break; }
}
idx = idx + 1;
}
try!(w.write(&header_buffer[..]));
2016-04-21 21:18:13 +02:00
}
2016-04-23 17:15:50 +02:00
try!((size as u64).to_bytes(&mut size_buffer[..], &mut fake_stack));
try!(w.write(&size_buffer[..]));
2016-04-21 21:18:13 +02:00
try!(w.write(&buffer[..]));
2016-04-21 21:18:13 +02:00
2016-04-23 17:15:50 +02:00
Ok(())
2016-04-25 01:43:21 +02:00
},
2016-04-23 17:15:50 +02:00
}
2016-04-21 21:18:13 +02:00
}
pub fn serialize<T: BinaryConvertable>(t: &T) -> Result<Vec<u8>, BinaryError> {
2016-04-22 18:45:09 +02:00
use std::io::Cursor;
let mut buff = Cursor::new(Vec::new());
try!(serialize_into(t, &mut buff));
let into_inner = buff.into_inner();
Ok(into_inner)
2016-04-22 18:45:09 +02:00
}
#[macro_export]
2016-04-20 18:01:53 +02:00
macro_rules! binary_fixed_size {
($target_ty: ty) => {
impl BinaryConvertable for $target_ty where $target_ty: Copy {
fn from_bytes(bytes: &[u8], _length_stack: &mut ::std::collections::VecDeque<usize>) -> Result<Self, BinaryConvertError> {
let size = ::std::mem::size_of::<$target_ty>();
match bytes.len().cmp(&size) {
::std::cmp::Ordering::Equal => (),
_ => return Err(BinaryConvertError::size(size, bytes.len())),
2016-04-20 18:01:53 +02:00
};
let res: Self = unsafe {
let mut temp = ::std::mem::zeroed();
let temp_ptr = &mut temp as *mut _ as *mut u8;
::std::ptr::copy_nonoverlapping(bytes.as_ptr(), temp_ptr, size);
temp
};
2016-04-20 18:01:53 +02:00
Ok(res)
}
fn to_bytes(&self, buffer: &mut [u8], _length_stack: &mut ::std::collections::VecDeque<usize>) -> Result<(), BinaryConvertError> {
2016-04-20 18:01:53 +02:00
let sz = ::std::mem::size_of::<$target_ty>();
let ip: *const $target_ty = self;
let ptr: *const u8 = ip as *const _;
unsafe {
::std::ptr::copy(ptr, buffer.as_mut_ptr(), sz);
}
Ok(())
}
}
}
}
2016-07-12 10:33:20 +02:00
/// Fixed-sized version of Handshake struct
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2016-07-12 10:33:20 +02:00
pub struct BinHandshake {
api_version: BinVersion,
protocol_version: BinVersion,
}
/// Shorten version of semver Version without `pre` and `build` information
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2016-07-12 10:33:20 +02:00
pub struct BinVersion {
pub major: u64,
pub minor: u64,
pub patch: u64,
}
impl From<Handshake> for BinHandshake {
fn from(other: Handshake) -> Self {
BinHandshake {
api_version: BinVersion::from(other.api_version),
protocol_version: BinVersion::from(other.protocol_version),
}
}
}
impl BinHandshake {
pub fn to_semver(self) -> Handshake {
Handshake {
api_version: self.api_version.to_semver(),
protocol_version: self.protocol_version.to_semver(),
}
}
}
impl BinVersion {
pub fn to_semver(self) -> ::semver::Version {
::semver::Version {
major: self.major,
minor: self.minor,
patch: self.patch,
pre: vec![],
build: vec![],
}
}
}
impl From<::semver::Version> for BinVersion {
fn from(other: ::semver::Version) -> Self {
BinVersion {
major: other.major,
minor: other.minor,
patch: other.patch,
}
}
}
binary_fixed_size!(u16);
2016-04-20 18:01:53 +02:00
binary_fixed_size!(u64);
binary_fixed_size!(u32);
2016-04-25 16:20:38 +02:00
binary_fixed_size!(usize);
2016-04-22 18:45:09 +02:00
binary_fixed_size!(i32);
2016-04-20 18:01:53 +02:00
binary_fixed_size!(bool);
2016-04-25 16:20:38 +02:00
binary_fixed_size!(U256);
binary_fixed_size!(U512);
2016-04-25 16:20:38 +02:00
binary_fixed_size!(H256);
2016-11-16 13:37:21 +01:00
binary_fixed_size!(H512);
2016-04-25 16:20:38 +02:00
binary_fixed_size!(H2048);
binary_fixed_size!(Address);
2016-07-12 10:33:20 +02:00
binary_fixed_size!(BinHandshake);
2016-12-11 22:47:43 +01:00
binary_fixed_size!(BinVersion);
impl BinaryConvertable for ::semver::Version {
fn from_bytes(bytes: &[u8], length_stack: &mut ::std::collections::VecDeque<usize>) -> Result<Self, BinaryConvertError> {
BinVersion::from_bytes(bytes, length_stack).map(BinVersion::to_semver)
}
fn to_bytes(&self, buffer: &mut [u8], length_stack: &mut ::std::collections::VecDeque<usize>) -> Result<(), BinaryConvertError> {
BinVersion::from(self.clone()).to_bytes(buffer, length_stack)
}
}
2016-04-21 21:18:13 +02:00
#[test]
fn vec_serialize() {
let mut v = Vec::new();
v.push(5u64);
v.push(10u64);
let mut length_stack = VecDeque::new();
let mut data = Vec::with_capacity(v.size());
unsafe { data.set_len(v.size()); }
let result = v.to_bytes(&mut data[..], &mut length_stack);
assert!(result.is_ok());
assert_eq!(5, data[0]);
assert_eq!(0, data[1]);
assert_eq!(10, data[8]);
assert_eq!(0, data[12]);
}
#[test]
fn calculates_size() {
let mut v = Vec::new();
v.push(5u64);
v.push(10u64);
assert_eq!(16, v.size());
}
#[test]
fn vec_deserialize() {
let data = [
10u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
5u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
];
let mut length_stack = VecDeque::new();
let vec = Vec::<u64>::from_bytes(&data[..], &mut length_stack).unwrap();
assert_eq!(vec![10u64, 5u64], vec);
}
#[test]
fn vec_deserialize_chained() {
let mut v = Vec::new();
v.push(Some(5u64));
v.push(Some(10u64));
v.push(None);
v.push(Some(12u64));
let mut length_stack = VecDeque::new();
let mut data = Vec::with_capacity(v.size());
unsafe { data.set_len(v.size()); }
let result = v.to_bytes(&mut data[..], &mut length_stack);
assert!(result.is_ok());
assert_eq!(4, length_stack.len());
}
#[test]
fn vec_serialize_deserialize() {
let mut v = Vec::new();
v.push(Some(5u64));
v.push(None);
v.push(Some(10u64));
v.push(None);
v.push(Some(12u64));
let mut data = Vec::with_capacity(v.size());
unsafe { data.set_len(v.size()); }
let mut length_stack = VecDeque::new();
v.to_bytes(&mut data[..], &mut length_stack).unwrap();
let de_v = Vec::<Option<u64>>::from_bytes(&data[..], &mut length_stack).unwrap();
assert_eq!(v, de_v);
}
#[test]
fn serialize_into_ok() {
use std::io::Cursor;
let mut buff = Cursor::new(vec![0; 128]);
let mut v = Vec::new();
v.push(Some(5u64));
v.push(None);
v.push(Some(10u64));
v.push(None);
v.push(Some(12u64));
serialize_into(&v, &mut buff).unwrap();
assert_eq!(5, buff.get_ref()[0]);
assert_eq!(8, buff.get_ref()[8]);
assert_eq!(0, buff.get_ref()[16]);
assert_eq!(8, buff.get_ref()[24]);
}
#[test]
fn deserialize_from_ok() {
use std::io::Cursor;
let mut buff = Cursor::new(vec![
0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
16u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
10u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
5u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
]);
let vec = deserialize_from::<Vec<u64>, _>(&mut buff).unwrap();
assert_eq!(vec![10u64, 5u64], vec);
}
#[test]
fn serialize_into_deserialize_from() {
use std::io::{Cursor, SeekFrom, Seek};
let mut buff = Cursor::new(Vec::new());
2016-04-21 21:18:13 +02:00
let mut v = Vec::new();
v.push(Some(5u64));
v.push(None);
v.push(Some(10u64));
v.push(None);
v.push(Some(12u64));
serialize_into(&v, &mut buff).unwrap();
buff.seek(SeekFrom::Start(0)).unwrap();
let de_v = deserialize_from::<Vec<Option<u64>>, _>(&mut buff).unwrap();
assert_eq!(v, de_v);
}
#[test]
fn serialize_vec_str() {
// empty
let source = Vec::<String>::new();
let serialized = serialize(&source).unwrap();
let deserialized = deserialize::<Vec<String>>(&serialized).unwrap();
assert_eq!(source, deserialized);
// with few values
let mut source = Vec::<String>::new();
source.push("val1".to_owned());
source.push("val2".to_owned());
let serialized = serialize(&source).unwrap();
let deserialized = deserialize::<Vec<String>>(&serialized).unwrap();
assert_eq!(source, deserialized);
}
#[test]
fn serialize_opt_str() {
// none
let source: Option<String> = None;
let serialized = serialize(&source).unwrap();
let deserialized = deserialize::<Option<String>>(&serialized).unwrap();
assert_eq!(source, deserialized);
// value
let source: Option<String> = Some("i have value".to_owned());
let serialized = serialize(&source).unwrap();
let deserialized = deserialize::<Option<String>>(&serialized).unwrap();
assert_eq!(source, deserialized);
}
#[test]
fn serialize_opt_vec() {
use std::io::Cursor;
let mut buff = Cursor::new(Vec::new());
let optional_vec: Option<Vec<u8>> = None;
serialize_into(&optional_vec, &mut buff).unwrap();
assert_eq!(&vec![0u8; 16], buff.get_ref());
}
#[test]
fn serialize_opt_vec_payload() {
let optional_vec: Option<Vec<u8>> = None;
let payload = serialize(&optional_vec).unwrap();
assert_eq!(vec![0u8;16], payload);
}
#[test]
fn deserialize_opt_vec() {
use std::io::Cursor;
let mut buff = Cursor::new(vec![0u8; 16]);
let vec = deserialize_from::<Option<Vec<u8>>, _>(&mut buff).unwrap();
assert!(vec.is_none());
}
#[test]
fn deserialize_simple_err() {
use std::io::Cursor;
let mut buff = Cursor::new(vec![0u8; 16]);
let result = deserialize_from::<Result<(), u32>, _>(&mut buff).unwrap();
assert!(result.is_ok());
}
#[test]
fn serialize_opt_vec_in_out() {
use std::io::{Cursor, SeekFrom, Seek};
let mut buff = Cursor::new(Vec::new());
let optional_vec: Option<Vec<u8>> = None;
serialize_into(&optional_vec, &mut buff).unwrap();
buff.seek(SeekFrom::Start(0)).unwrap();
let vec = deserialize_from::<Option<Vec<u8>>, _>(&mut buff).unwrap();
assert!(vec.is_none());
}
#[test]
fn serialize_err_opt_vec_in_out() {
use std::io::{Cursor, SeekFrom, Seek};
let mut buff = Cursor::new(Vec::new());
let optional_vec: Result<Option<Vec<u8>>, u32> = Ok(None);
serialize_into(&optional_vec, &mut buff).unwrap();
buff.seek(SeekFrom::Start(0)).unwrap();
let vec = deserialize_from::<Result<Option<Vec<u8>>, u32>, _>(&mut buff).unwrap();
assert!(vec.is_ok());
}
#[test]
fn serialize_btree() {
use std::io::{Cursor, SeekFrom, Seek};
let mut buff = Cursor::new(Vec::new());
let mut btree = BTreeMap::new();
btree.insert(1u64, 5u64);
serialize_into(&btree, &mut buff).unwrap();
buff.seek(SeekFrom::Start(0)).unwrap();
let res = deserialize_from::<BTreeMap<u64, u64>, _>(&mut buff).unwrap();
assert_eq!(res[&1u64], 5u64);
}
2016-07-12 10:33:20 +02:00
#[test]
fn serialize_refcell() {
use std::cell::RefCell;
let source = RefCell::new(vec![5u32, 12u32, 19u32]);
let serialized = serialize(&source).unwrap();
let deserialized = deserialize::<RefCell<Vec<u32>>>(&serialized).unwrap();
assert_eq!(source, deserialized);
}
#[test]
fn serialize_cell() {
use std::cell::Cell;
use std::str::FromStr;
let source = Cell::new(U256::from_str("01231231231239999").unwrap());
let serialized = serialize(&source).unwrap();
let deserialized = deserialize::<Cell<U256>>(&serialized).unwrap();
assert_eq!(source, deserialized);
}
2016-07-12 10:33:20 +02:00
#[test]
fn serialize_handshake() {
use std::io::{Cursor, SeekFrom, Seek};
let mut buff = Cursor::new(Vec::new());
let handshake = Handshake {
api_version: ::semver::Version::parse("1.2.0").unwrap(),
protocol_version: ::semver::Version::parse("1.2.0").unwrap(),
};
serialize_into(&BinHandshake::from(handshake.clone()), &mut buff).unwrap();
buff.seek(SeekFrom::Start(0)).unwrap();
let res = deserialize_from::<BinHandshake, _>(&mut buff).unwrap().to_semver();
assert_eq!(res, handshake);
}
#[test]
fn serialize_invalid_size() {
// value
let deserialized = deserialize::<u64>(&[]);
match deserialized {
Err(BinaryError::Serialization(
BinaryConvertError {
kind: BinaryConvertErrorKind::SizeMismatch { expected: 8, found: 0 },
member_tree: _
})) => {},
other => panic!("Not a size mismatched error but: {:?}", other),
}
}
#[test]
fn serialize_boundaries() {
// value
let deserialized = deserialize::<Vec<u32>>(
&[
// payload header
0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
2u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
//
0u8, 0u8, 0u8, 5u8,
0u8, 0u8, 0u8, 4u8,
1u8, 1u8, /* not 4 bytes */
]
);
match deserialized {
Err(BinaryError::Serialization(
BinaryConvertError {
kind: BinaryConvertErrorKind::InconsistentBoundaries,
member_tree: _
})) => {},
other => panic!("Not an inconsistent boundaries error but: {:?}", other),
}
}
2016-07-12 10:33:20 +02:00
#[test]
fn serialize_empty_try() {
// value
let mut stack = VecDeque::new();
let mut data = vec![0u8; 16];
let sample: Option<Vec<u8>> = None;
let serialized = sample.to_bytes(&mut data, &mut stack);
match serialized {
Err(BinaryConvertError {
kind: BinaryConvertErrorKind::TargetPayloadEmpty,
member_tree: _
}) => {},
other => panic!("Not an error about empty payload to be produced but: {:?}", other),
}
}
#[test]
fn serialize_not_enough_lengths() {
// value
let deserialized = deserialize::<Vec<Option<u32>>>(
&[
// payload header
0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
2u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
// does not matter because no length param for the first option
0u8,
]
);
match deserialized {
Err(BinaryError::Serialization(
BinaryConvertError {
kind: BinaryConvertErrorKind::MissingLengthValue,
member_tree: _
})) => {},
other => panic!("Not an missing length param error but: {:?}", other),
}
2016-07-12 10:33:20 +02:00
}
#[test]
fn vec_of_vecs() {
let sample = vec![vec![5u8, 10u8], vec![], vec![9u8, 11u8]];
let serialized = serialize(&sample).unwrap();
let deserialized = deserialize::<Vec<Vec<u8>>>(&serialized).unwrap();
assert_eq!(sample, deserialized);
// empty
let sample: Vec<Vec<u8>> = vec![];
let serialized = serialize(&sample).unwrap();
let deserialized = deserialize::<Vec<Vec<u8>>>(&serialized).unwrap();
assert_eq!(sample, deserialized);
}