berkus
/
bincode-orig
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:TyOverby/bincode 

Conflicts:
	src/reader.rs
This commit is contained in:
Ty Overby 2015-01-07 22:30:43 -08:00
parent bb0c8e4fe3 cb0ef826f9
commit dab27229b4
3 changed files with 164 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib.rs
View File

@ -13,7 +13,7 @@ use rustc_serialize::Encodable;
use rustc_serialize::Decodable;
pub use writer::EncoderWriter;
pub use reader::DecoderReader;
pub use reader::{DecoderReader, DecodingResult, DecodingError};
mod writer;
mod reader;
@ -32,7 +32,7 @@ pub fn encode<T: Encodable>(t: &T, size_limit: SizeLimit) -> IoResult<Vec<u8>> {
}
}
pub fn decode<T: Decodable>(b: Vec<u8>, size_limit: SizeLimit) -> IoResult<T> {
pub fn decode<T: Decodable>(b: Vec<u8>, size_limit: SizeLimit) -> DecodingResult<T> {
decode_from(&mut MemReader::new(b), size_limit)
}
@ -40,7 +40,7 @@ pub fn encode_into<T: Encodable, W: Writer>(t: &T, w: &mut W, size_limit: SizeLi
t.encode(&mut writer::EncoderWriter::new(w, size_limit))
}
pub fn decode_from<R: Reader+Buffer, T: Decodable>(r: &mut R, size_limit: SizeLimit) -> IoResult<T> {
pub fn decode_from<R: Reader+Buffer, T: Decodable>(r: &mut R, size_limit: SizeLimit) -> DecodingResult<T> {
Decodable::decode(&mut reader::DecoderReader::new(r, size_limit))
}

228
src/reader.rs
View File

@ -1,11 +1,54 @@
use std::io::{Buffer, Reader, IoError, IoResult, OtherIoError};
use std::num::{cast, NumCast};
use std::error::Error;
use std::error::{Error, FromError};
use rustc_serialize::Decoder;
use super::SizeLimit;
#[derive(PartialEq, Clone, Show)]
pub struct InvalidBytes {
desc: &'static str,
detail: Option<String>,
}
#[derive(PartialEq, Clone, Show)]
pub enum DecodingError {
IoError(IoError),
InvalidBytes(InvalidBytes),
SizeLimit
}
pub type DecodingResult<T> = Result<T, DecodingError>;
fn wrap_io(err: IoError) -> DecodingError {
DecodingError::IoError(err)
}
impl Error for DecodingError {
fn description(&self) -> &str {
match *self {
DecodingError::IoError(ref err) => err.description(),
DecodingError::InvalidBytes(ref ib) => ib.desc,
DecodingError::SizeLimit => "the size limit for decoding has been reached"
}
}
fn detail(&self) -> Option<String> {
match *self {
DecodingError::IoError(ref err) => err.detail(),
DecodingError::InvalidBytes(ref ib) => ib.detail.clone(),
DecodingError::SizeLimit => None
}
}
}
impl FromError<IoError> for DecodingError {
fn from_error(err: IoError) -> DecodingError {
DecodingError::IoError(err)
}
}
pub struct DecoderReader<'a, R: 'a> {
reader: &'a mut R,
size_limit: SizeLimit,
@ -23,194 +66,201 @@ impl<'a, R: Reader+Buffer> DecoderReader<'a, R> {
}
impl <'a, A> DecoderReader<'a, A> {
fn read_bytes<I>(&mut self, count: I) -> Result<(), IoError>
fn read_bytes<I>(&mut self, count: I) -> Result<(), DecodingError>
where I: NumCast {
self.read += cast(count).unwrap();
match self.size_limit {
SizeLimit::Infinite => Ok(()),
SizeLimit::UpperBound(x) if self.read <= x => Ok(()),
SizeLimit::UpperBound(_) => Err(IoError{
kind: OtherIoError,
desc: "The max number of bytes has been read from this reader.",
detail: None
})
SizeLimit::UpperBound(_) => Err(DecodingError::SizeLimit)
}
}
fn read_type<T>(&mut self) -> Result<(), IoError> {
fn read_type<T>(&mut self) -> Result<(), DecodingError> {
use std::intrinsics::size_of;
unsafe{ self.read_bytes(size_of::<T>()) }
}
}
impl<'a, R: Reader+Buffer> Decoder for DecoderReader<'a, R> {
type Error = IoError;
type Error = DecodingError;
fn read_nil(&mut self) -> IoResult<()> {
fn read_nil(&mut self) -> DecodingResult<()> {
Ok(())
}
fn read_uint(&mut self) -> IoResult<uint> {
self.read_u64().map(|x| x as uint)
fn read_uint(&mut self) -> DecodingResult<uint> {
Ok(try!(self.read_u64().map(|x| x as uint)))
}
fn read_u64(&mut self) -> IoResult<u64> {
fn read_u64(&mut self) -> DecodingResult<u64> {
try!(self.read_type::<u64>());
self.reader.read_be_u64()
self.reader.read_be_u64().map_err(wrap_io)
}
fn read_u32(&mut self) -> IoResult<u32> {
fn read_u32(&mut self) -> DecodingResult<u32> {
try!(self.read_type::<u32>());
self.reader.read_be_u32()
self.reader.read_be_u32().map_err(wrap_io)
}
fn read_u16(&mut self) -> IoResult<u16> {
fn read_u16(&mut self) -> DecodingResult<u16> {
try!(self.read_type::<u16>());
self.reader.read_be_u16()
self.reader.read_be_u16().map_err(wrap_io)
}
fn read_u8(&mut self) -> IoResult<u8> {
fn read_u8(&mut self) -> DecodingResult<u8> {
try!(self.read_type::<u8>());
self.reader.read_u8()
self.reader.read_u8().map_err(wrap_io)
}
fn read_int(&mut self) -> IoResult<int> {
fn read_int(&mut self) -> DecodingResult<int> {
self.read_i64().map(|x| x as int)
}
fn read_i64(&mut self) -> IoResult<i64> {
fn read_i64(&mut self) -> DecodingResult<i64> {
try!(self.read_type::<i64>());
self.reader.read_be_i64()
self.reader.read_be_i64().map_err(wrap_io)
}
fn read_i32(&mut self) -> IoResult<i32> {
fn read_i32(&mut self) -> DecodingResult<i32> {
try!(self.read_type::<i32>());
self.reader.read_be_i32()
self.reader.read_be_i32().map_err(wrap_io)
}
fn read_i16(&mut self) -> IoResult<i16> {
fn read_i16(&mut self) -> DecodingResult<i16> {
try!(self.read_type::<i16>());
self.reader.read_be_i16()
self.reader.read_be_i16().map_err(wrap_io)
}
fn read_i8(&mut self) -> IoResult<i8> {
fn read_i8(&mut self) -> DecodingResult<i8> {
try!(self.read_type::<i8>());
self.reader.read_i8()
self.reader.read_i8().map_err(wrap_io)
}
fn read_bool(&mut self) -> IoResult<bool> {
match try!(self.read_i8()) {
fn read_bool(&mut self) -> DecodingResult<bool> {
let x = try!(self.read_i8());
match x {
1 => Ok(true),
_ => Ok(false)
0 => Ok(false),
_ => Err(DecodingError::InvalidBytes(InvalidBytes{
desc: "invalid u8 when decoding bool",
detail: Some(format!("Expected 0 or 1, got {}", x))
})),
}
}
fn read_f64(&mut self) -> IoResult<f64> {
fn read_f64(&mut self) -> DecodingResult<f64> {
try!(self.read_type::<f64>());
self.reader.read_be_f64()
self.reader.read_be_f64().map_err(wrap_io)
}
fn read_f32(&mut self) -> IoResult<f32> {
fn read_f32(&mut self) -> DecodingResult<f32> {
try!(self.read_type::<f32>());
self.reader.read_be_f32()
self.reader.read_be_f32().map_err(wrap_io)
}
fn read_char(&mut self) -> IoResult<char> {
fn read_char(&mut self) -> DecodingResult<char> {
try!(self.read_type::<char>());
self.reader.read_char()
self.reader.read_char().map_err(wrap_io)
}
fn read_str(&mut self) -> IoResult<String> {
fn read_str(&mut self) -> DecodingResult<String> {
let len = try!(self.read_uint());
try!(self.read_bytes(len));
let vector = try!(self.reader.read_exact(len));
String::from_utf8(vector).map_err(|e| IoError {
kind: OtherIoError,
desc: "invalid utf-8",
detail: e.detail()
})
match String::from_utf8(vector) {
Ok(s) => Ok(s),
Err(err) => Err(DecodingError::InvalidBytes(InvalidBytes {
desc: "error while decoding utf8 string",
detail: Some(format!("Decoding error: {}", err))
})),
}
fn read_enum<T, F>(&mut self, _: &str, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
}
fn read_enum<T, F>(&mut self, _: &str, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
f(self)
}
fn read_enum_variant<T, F>(&mut self, names: &[&str], mut f: F) -> IoResult<T> where
F: FnMut(&mut DecoderReader<'a, R>, uint) -> IoResult<T> {
fn read_enum_variant<T, F>(&mut self, names: &[&str], mut f: F) -> DecodingResult<T> where
F: FnMut(&mut DecoderReader<'a, R>, uint) -> DecodingResult<T> {
let id = try!(self.read_u32());
let id = id as uint;
if id >= names.len() {
Err(IoError {
kind: OtherIoError,
Err(DecodingError::InvalidBytes(InvalidBytes {
desc: "out of bounds tag when reading enum variant",
detail: Some(format!("Expected tag < {}, got {}", names.len(), id))
})
}))
} else {
f(self, id)
}
}
fn read_enum_variant_arg<T, F>(&mut self, _: uint, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
fn read_enum_variant_arg<T, F>(&mut self, _: uint, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
f(self)
}
fn read_enum_struct_variant<T, F>(&mut self, names: &[&str], f: F) -> IoResult<T> where
F: FnMut(&mut DecoderReader<'a, R>, uint) -> IoResult<T> {
fn read_enum_struct_variant<T, F>(&mut self, names: &[&str], f: F) -> DecodingResult<T> where
F: FnMut(&mut DecoderReader<'a, R>, uint) -> DecodingResult<T> {
self.read_enum_variant(names, f)
}
fn read_enum_struct_variant_field<T, F>(&mut self,
_: &str,
f_idx: uint,
f: F)
-> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
-> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
self.read_enum_variant_arg(f_idx, f)
}
fn read_struct<T, F>(&mut self, _: &str, _: uint, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
fn read_struct<T, F>(&mut self, _: &str, _: uint, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
f(self)
}
fn read_struct_field<T, F>(&mut self,
_: &str,
_: uint,
f: F)
-> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
-> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
f(self)
}
fn read_tuple<T, F>(&mut self, _: uint, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
fn read_tuple<T, F>(&mut self, _: uint, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
f(self)
}
fn read_tuple_arg<T, F>(&mut self, _: uint, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
fn read_tuple_arg<T, F>(&mut self, _: uint, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
f(self)
}
fn read_tuple_struct<T, F>(&mut self, _: &str, len: uint, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
fn read_tuple_struct<T, F>(&mut self, _: &str, len: uint, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
self.read_tuple(len, f)
}
fn read_tuple_struct_arg<T, F>(&mut self, a_idx: uint, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
fn read_tuple_struct_arg<T, F>(&mut self, a_idx: uint, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
self.read_tuple_arg(a_idx, f)
}
fn read_option<T, F>(&mut self, mut f: F) -> IoResult<T> where
F: FnMut(&mut DecoderReader<'a, R>, bool) -> IoResult<T> {
match try!(self.read_u8()) {
fn read_option<T, F>(&mut self, mut f: F) -> DecodingResult<T> where
F: FnMut(&mut DecoderReader<'a, R>, bool) -> DecodingResult<T> {
let x = try!(self.read_u8());
match x {
1 => f(self, true),
_ => f(self, false)
0 => f(self, false),
_ => Err(DecodingError::InvalidBytes(InvalidBytes {
desc: "invalid tag when decoding Option",
detail: Some(format!("Expected 0 or 1, got {}", x))
})),
}
}
fn read_seq<T, F>(&mut self, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>, uint) -> IoResult<T> {
fn read_seq<T, F>(&mut self, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>, uint) -> DecodingResult<T> {
let len = try!(self.read_uint());
f(self, len)
}
fn read_seq_elt<T, F>(&mut self, _: uint, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
fn read_seq_elt<T, F>(&mut self, _: uint, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
f(self)
}
fn read_map<T, F>(&mut self, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>, uint) -> IoResult<T> {
fn read_map<T, F>(&mut self, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>, uint) -> DecodingResult<T> {
let len = try!(self.read_uint());
f(self, len)
}
fn read_map_elt_key<T, F>(&mut self, _: uint, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
fn read_map_elt_key<T, F>(&mut self, _: uint, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
f(self)
}
fn read_map_elt_val<T, F>(&mut self, _: uint, f: F) -> IoResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> IoResult<T> {
fn read_map_elt_val<T, F>(&mut self, _: uint, f: F) -> DecodingResult<T> where
F: FnOnce(&mut DecoderReader<'a, R>) -> DecodingResult<T> {
f(self)
}
fn error(&mut self, err: &str) -> IoError {
IoError {
kind: OtherIoError,
desc: "failure decoding or something, I don't know",
detail: Some(err.to_string())
}
fn error(&mut self, err: &str) -> DecodingError {
DecodingError::InvalidBytes(InvalidBytes {
desc: "user-induced error",
detail: Some(err.to_string()),
})
}
}

30
src/test.rs
View File

@ -13,6 +13,8 @@ use rustc_serialize::{
use super::{
encode,
decode,
DecodingError,
DecodingResult
};
use super::SizeLimit::{Infinite, UpperBound};
@ -49,7 +51,6 @@ fn test_numbers() {
fn test_string() {
the_same("".to_string());
the_same("a".to_string());
the_same("ƒoo".to_string());
}
#[test]
@ -166,14 +167,27 @@ fn unicode() {
the_same("aåååååååa".to_string());
}
#[test]
fn bad_unicode() {
// This is a malformed message that contains bad utf8.
// The decoding should return Err but not panic.
let encoded = vec![0,0,0,0, 0,0,0,2, 97, 195];
let decoded: Result<String, _> = decode(encoded, Infinite);
fn is_invalid_bytes<T>(res: DecodingResult<T>) {
match res {
Ok(_) => panic!("Expecting error"),
Err(DecodingError::IoError(_)) => panic!("Expecting InvalidBytes"),
Err(DecodingError::SizeLimit) => panic!("Expecting InvalidBytes"),
Err(DecodingError::InvalidBytes(_)) => {},
}
}
assert!(decoded.is_err());
#[test]
fn decoding_errors() {
is_invalid_bytes(decode::<bool>(vec![0xA], Infinite));
is_invalid_bytes(decode::<String>(vec![0, 0, 0, 0, 0, 0, 0, 1, 0xFF], Infinite));
// Out-of-bounds variant
#[derive(RustcEncodable, RustcDecodable)]
enum Test {
One,
Two,
};
is_invalid_bytes(decode::<Test>(vec![0, 0, 0, 5], Infinite));
is_invalid_bytes(decode::<Option<u8>>(vec![5, 0], Infinite));
}
#[test]