changeset 9:020bfec8699f

Improve docs, make tests pass
author Lewin Bormann <lbo@spheniscida.de>
date Sat, 30 Jan 2016 22:01:54 +0000
parents bb148e9edb78
children 3f35e5705cc2
files Cargo.toml src/formats/writelog.rs src/util.rs
diffstat 3 files changed, 6 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/Cargo.toml	Sat Jan 30 21:57:26 2016 +0000
+++ b/Cargo.toml	Sat Jan 30 22:01:54 2016 +0000
@@ -2,3 +2,6 @@
 name = "localmr"
 version = "0.1.0"
 authors = ["Lewin Bormann <lbo@spheniscida.de>"]
+
+[dependencies]
+time = "0.1.34"
--- a/src/formats/writelog.rs	Sat Jan 30 21:57:26 2016 +0000
+++ b/src/formats/writelog.rs	Sat Jan 30 22:01:54 2016 +0000
@@ -19,9 +19,7 @@
 /// that is a sequence of bytestring.
 /// It can be read back in relatively efficiently and yields the same byte
 /// strings; on disk, it is represented as records prefixed by 4 byte
-/// big-endian length prefixes:
-/// 
-///      llllbbbbbbllllbbllllbbbbbbbbb...
+/// big-endian length prefixes: `llllbbbbbbllllbbllllbbbbbbbbb...`
 /// 
 /// Where l is a length byte and b are bytes of a bytestring.
 /// 
--- a/src/util.rs	Sat Jan 30 21:57:26 2016 +0000
+++ b/src/util.rs	Sat Jan 30 22:01:54 2016 +0000
@@ -3,7 +3,8 @@
 
 /// Transforms an iterator<string> into an iterator<Record>. It yields
 /// records with the key being the position of the current record, starting with
-/// 1.
+/// 1. Mainly used as input iterator in the mapping phase, from sources that only
+/// yield values (no keys).
 pub struct RecordIterator {
     i: Box<Iterator<Item=String>>,
     counter: u64,