ValueRef

CHANGELOG.md

@@ -6,6 +6,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - FixedValue* -> FixVal*
 
 ## [Unreleased][unreleased]
+- Nothing yet.
+
+## 0.4.0 - 2015-07-17
+### Added
+- Low level `write_str` function allows to serialize the UTF-8 encoded strings the most efficient way.
+- Low level `write_bin` function allows to serialize the binary array the most efficient way.
 - Implemented `std::error::Error` trait for error types.
 
 ## 0.3.2 - 2015-07-05

benches/bench.rs

@@ -39,6 +39,21 @@ fn from_string_read_value(b: &mut Bencher) {
     });
 }
 
+#[bench]
+fn from_string_read_value_ref(b: &mut Bencher) {
+    // Lorem ipsum dolor sit amet.
+    let buf = [
+        0xbb, 0x4c, 0x6f, 0x72, 0x65, 0x6d, 0x20, 0x69, 0x70, 0x73, 0x75,
+        0x6d, 0x20, 0x64, 0x6f, 0x6c, 0x6f, 0x72, 0x20, 0x73, 0x69, 0x74,
+        0x20, 0x61, 0x6d, 0x65, 0x74, 0x2e
+    ];
+
+    b.iter(|| {
+        let res = read_value_ref(&mut &buf[..]).unwrap();
+        test::black_box(res);
+    });
+}
+
 #[bench]
 fn from_complex_read_value(b: &mut Bencher) {
     let buf = [
@@ -61,6 +76,49 @@ fn from_complex_read_value(b: &mut Bencher) {
     });
 }
 
+#[bench]
+fn from_complex_read_value_ref(b: &mut Bencher) {
+    let buf = [
+        0x95, // Fixed array with 5 len.
+        0xc0, // Nil.
+        0x2a, // 42.
+        0xcb, 0x40, 0x9, 0x21, 0xca, 0xc0, 0x83, 0x12, 0x6f, // 3.1415
+        // Fixed string with "Lorem ipsum dolor sit amet." content.
+        0xbb, 0x4c, 0x6f, 0x72, 0x65, 0x6d, 0x20, 0x69, 0x70, 0x73, 0x75,
+        0x6d, 0x20, 0x64, 0x6f, 0x6c, 0x6f, 0x72, 0x20, 0x73, 0x69, 0x74,
+        0x20, 0x61, 0x6d, 0x65, 0x74, 0x2e,
+        0x81, // Fixed map with 1 len.
+        0xa3, 0x6b, 0x65, 0x79, // Key "key".
+        0xa5, 0x76, 0x61, 0x6c, 0x75, 0x65 // Value: "value".
+    ];
+
+    b.iter(|| {
+        let res = read_value_ref(&mut &buf[..]).unwrap();
+        test::black_box(res);
+    });
+}
+
+#[bench]
+fn from_complex_read_value_ref_to_owned(b: &mut Bencher) {
+    let buf = [
+        0x95, // Fixed array with 5 len.
+        0xc0, // Nil.
+        0x2a, // 42.
+        0xcb, 0x40, 0x9, 0x21, 0xca, 0xc0, 0x83, 0x12, 0x6f, // 3.1415
+        // Fixed string with "Lorem ipsum dolor sit amet." content.
+        0xbb, 0x4c, 0x6f, 0x72, 0x65, 0x6d, 0x20, 0x69, 0x70, 0x73, 0x75,
+        0x6d, 0x20, 0x64, 0x6f, 0x6c, 0x6f, 0x72, 0x20, 0x73, 0x69, 0x74,
+        0x20, 0x61, 0x6d, 0x65, 0x74, 0x2e,
+        0x81, // Fixed map with 1 len.
+        0xa3, 0x6b, 0x65, 0x79, // Key "key".
+        0xa5, 0x76, 0x61, 0x6c, 0x75, 0x65 // Value: "value".
+    ];
+
+    b.iter(|| {
+        let res = read_value_ref(&mut &buf[..]).unwrap().to_owned();
+        test::black_box(res);
+    });
+}
 
 #[bench]
 fn from_i64_read_i64_loosely(b: &mut Bencher) {

src/decode.rs

@@ -24,6 +24,10 @@ use byteorder::ReadBytesExt;
 
 use super::Marker;
 
+#[path = "decode/value_ref.rs"]
+pub mod value_ref;
+pub use self::value_ref::read_value_ref;
+
 /// Represents an error that can occur when attempting to read bytes from the reader.
 ///
 /// This is a thin wrapper over the standard `io::Error` type. Namely, it adds one additional error
@@ -40,6 +44,7 @@ impl Error for ReadError {
     fn description(&self) -> &str {
         match *self {
             ReadError::UnexpectedEOF => "unexpected end of file while reading MessagePack value",
+            // TODO: Probably we should give here a short description that I/O error occurs.
             ReadError::Io(ref err) => err.description(),
         }
     }
@@ -1038,6 +1043,7 @@ fn read_str_data<'r, R>(rd: &mut R, len: u32, buf: &'r mut[u8]) -> Result<&'r st
 ///
 // TODO: it is better to return &str; may panic on len mismatch; extend documentation.
 // TODO: Also it's possible to implement all borrowing functions for all `BufRead` implementors.
+// TODO: It's not necessary to use cursor, use slices instead.
 pub fn read_str_ref(rd: &[u8]) -> Result<&[u8], DecodeStringError> {
     let mut cur = io::Cursor::new(rd);
     let len = try!(read_str_len(&mut cur));