issue/96 Added unit test, documentation and various tiny improvements.

1 files changed, 6 insertions, 3 deletions

diff --git a/src/common/mod.rs b/src/common/mod.rs
index d2d41ce..c99c37f 100644
--- a/src/common/mod.rs
+++ b/src/common/mod.rs
@@ -3,16 +3,15 @@ mod timer;
 mod vint;
 pub mod bitpacker;
 
-
 pub use self::serialize::BinarySerializable;
 pub use self::timer::Timing;
 pub use self::timer::TimerTree;
 pub use self::timer::OpenTimer;
 pub use self::vint::VInt;
 
-
 use std::io;
 
+/// Create a default io error given a string.
 pub fn make_io_err(msg: String) -> io::Error {
     io::Error::new(io::ErrorKind::Other, msg)
 }
@@ -30,7 +29,11 @@ pub trait HasLen {
 }
 
 
-pub fn create_vec_with_len<T>(capacity: usize) -> Vec<T> {
+/// Creates an uninitialized Vec of a given usize
+///
+/// `allocate_vec` does an unsafe call to `set_len`
+/// as other solution are extremely slow in debug mode.
+pub fn allocate_vec<T>(capacity: usize) -> Vec<T> {
     let mut v = Vec::with_capacity(capacity);
     unsafe {
         v.set_len(capacity);