format

Signed-off-by: Alex Chi <[email protected]>

src/util.rs

@@ -63,6 +63,7 @@ where
     i
 }
 
+/// Fill a file with 0.
 pub fn fill_file(file: &mut impl std::io::Write, mut size: u64) -> Result<()> {
     let buf = vec![0; 4096];
     let buf_len = buf.len() as u64;

src/value.rs

@@ -14,6 +14,7 @@ pub const VALUE_MERGE_ENTRY: u8 = 1 << 3;
 pub const VALUE_TXN: u8 = 1 << 6;
 pub const VALUE_FIN_TXN: u8 = 1 << 7;
 
+/// Value of a kv pair is packed into `Value` struct with extra information.
 #[derive(Default, Debug, Clone)]
 pub struct Value {
     pub meta: u8,
@@ -135,16 +136,19 @@ impl Value {
     }
 }
 
+/// A request contains multiple entries to be written into LSM tree.
 pub struct Request {
     pub entries: Vec<Entry>,
 }
 
+/// `ValuePointer` records the position of value saved in value log.
 pub struct ValuePointer {
     pub file_id: u32,
     pub len: u32,
     pub offset: u32,
 }
 
+/// `EntryReader` reads entries from `BufReader`.
 pub struct EntryReader {
     key: Vec<u8>,
     value: Vec<u8>,