Adding support for RDB version <= 12 and refactoring

Cargo.toml

@@ -1,15 +1,12 @@
 [package]
-
 name = "rdb"
-version = "0.2.1"
-authors = ["Jan-Erik Rediger <[email protected]>"]
-
-keywords = ["redis", "database"]
+edition = "2021"
+version = "0.3.0"
+authors = ["Jan-Erik Rediger <[email protected]>", "Tim Bauer <[email protected]>"]
+keywords = ["redis", "database", "rdb", "parser"]
 description = "Fast and efficient RDB parsing utility"
-
 readme = "README.md"
 license = "MIT"
-
 homepage = "http://rdb.fnordig.de/"
 documentation = "http://rdb.fnordig.de/doc/rdb/"
 repository = "https://github.com/badboy/rdb-rs"
@@ -34,3 +31,8 @@ getopts = "0.2"
 rustc-serialize = "0.3"
 regex = "0.1"
 byteorder = "0.5"
+thiserror = "1.0"
+clap = { version = "4.4", features = ["derive"] }
+
+[dev-dependencies]
+rstest = "0.23.0"

src/constants.rs

@@ -1,42 +1,42 @@
 pub mod version {
-    pub const SUPPORTED_MINIMUM : u32 = 1;
-    pub const SUPPORTED_MAXIMUM : u32 = 12;
+    pub const SUPPORTED_MINIMUM: u32 = 1;
+    pub const SUPPORTED_MAXIMUM: u32 = 12;
 }
 
 pub mod constant {
-    pub const RDB_6BITLEN : u8 = 0;
-    pub const RDB_14BITLEN : u8 = 1;
-    pub const RDB_ENCVAL : u8 = 3;
-    pub const RDB_MAGIC : &'static str = "REDIS";
+    pub const RDB_6BITLEN: u8 = 0;
+    pub const RDB_14BITLEN: u8 = 1;
+    pub const RDB_ENCVAL: u8 = 3;
+    pub const RDB_MAGIC: &'static str = "REDIS";
 }
 
 pub mod op_code {
     pub const MODULE_AUX: u8 = 247;
     pub const IDLE: u8 = 248;
     pub const FREQ: u8 = 249;
-    pub const AUX : u8 = 250;
-    pub const RESIZEDB : u8 = 251;
-    pub const EXPIRETIME_MS : u8 = 252;
-    pub const EXPIRETIME : u8 = 253;
-    pub const SELECTDB   : u8 = 254;
-    pub const EOF : u8 = 255;
+    pub const AUX: u8 = 250;
+    pub const RESIZEDB: u8 = 251;
+    pub const EXPIRETIME_MS: u8 = 252;
+    pub const EXPIRETIME: u8 = 253;
+    pub const SELECTDB: u8 = 254;
+    pub const EOF: u8 = 255;
 }
 
 pub mod encoding_type {
-    pub const STRING : u8 = 0;
-    pub const LIST : u8 = 1;
-    pub const SET : u8 = 2;
-    pub const ZSET : u8 = 3;
-    pub const HASH : u8 = 4;
+    pub const STRING: u8 = 0;
+    pub const LIST: u8 = 1;
+    pub const SET: u8 = 2;
+    pub const ZSET: u8 = 3;
+    pub const HASH: u8 = 4;
     pub const ZSET_2: u8 = 5;
     pub const MODULE: u8 = 6;
     pub const MODULE_2: u8 = 7;
-    pub const HASH_ZIPMAP : u8 = 9;
-    pub const LIST_ZIPLIST : u8 = 10;
-    pub const SET_INTSET : u8 = 11;
-    pub const ZSET_ZIPLIST : u8 = 12;
-    pub const HASH_ZIPLIST : u8 = 13;
-    pub const LIST_QUICKLIST : u8 = 14;
+    pub const HASH_ZIPMAP: u8 = 9;
+    pub const LIST_ZIPLIST: u8 = 10;
+    pub const SET_INTSET: u8 = 11;
+    pub const ZSET_ZIPLIST: u8 = 12;
+    pub const HASH_ZIPLIST: u8 = 13;
+    pub const LIST_QUICKLIST: u8 = 14;
     pub const STREAM_LIST_PACKS: u8 = 15;
     pub const HASH_LIST_PACK: u8 = 16;
     pub const ZSET_LIST_PACK: u8 = 17;
@@ -47,8 +47,8 @@ pub mod encoding_type {
 }
 
 pub mod encoding {
-    pub const INT8 : u32 = 0;
-    pub const INT16 : u32 = 1;
-    pub const INT32 : u32 = 2;
-    pub const LZF : u32 = 3;
+    pub const INT8: u32 = 0;
+    pub const INT16: u32 = 1;
+    pub const INT32: u32 = 2;
+    pub const LZF: u32 = 3;
 }

src/filter.rs

@@ -1,23 +1,30 @@
-use std::str;
+use crate::types::Type;
 use regex::Regex;
-use types::Type;
+use std::str;
 
 pub trait Filter {
-    fn matches_db(&self, _db: u32) -> bool { true }
-    fn matches_type(&self, _enc_type: u8) -> bool { true }
-    fn matches_key(&self, _key: &[u8]) -> bool { true }
-
+    fn matches_db(&self, _db: u32) -> bool {
+        true
+    }
+    fn matches_type(&self, _enc_type: u8) -> bool {
+        true
+    }
+    fn matches_key(&self, _key: &[u8]) -> bool {
+        true
+    }
 }
 
 #[derive(Default)]
 pub struct Simple {
     databases: Vec<u32>,
     types: Vec<Type>,
-    keys: Option<Regex>
+    keys: Option<Regex>,
 }
 
 impl Simple {
-    pub fn new() -> Simple { Simple::default() }
+    pub fn new() -> Simple {
+        Simple::default()
+    }
 
     pub fn add_database(&mut self, db: u32) {
         self.databases.push(db);
@@ -43,7 +50,7 @@ impl Filter for Simple {
 
     fn matches_type(&self, enc_type: u8) -> bool {
         if self.types.is_empty() {
-            return true
+            return true;
         }
 
         let typ = Type::from_encoding(enc_type);
@@ -54,7 +61,7 @@ impl Filter for Simple {
         match self.keys.clone() {
             None => true,
             Some(re) => {
-                let key = unsafe{str::from_utf8_unchecked(key)};
+                let key = unsafe { str::from_utf8_unchecked(key) };
                 re.is_match(key)
             }
         }

src/formatter/json.rs

@@ -1,20 +1,20 @@
 #![allow(unused_must_use)]
 
-use formatter::Formatter;
+use super::write_str;
+use crate::formatter::Formatter;
+use crate::types::EncodingType;
+use serialize::json;
 use std::io;
 use std::io::Write;
 use std::str;
-use serialize::json;
-use types::EncodingType;
-use super::write_str;
 
 pub struct JSON {
-    out: Box<Write+'static>,
+    out: Box<dyn Write + 'static>,
     is_first_db: bool,
     has_databases: bool,
     is_first_key_in_db: bool,
     elements_in_key: u32,
-    element_index: u32
+    element_index: u32,
 }
 
 impl JSON {
@@ -26,13 +26,13 @@ impl JSON {
             has_databases: false,
             is_first_key_in_db: true,
             elements_in_key: 0,
-            element_index: 0
+            element_index: 0,
         }
     }
 }
 
 fn encode_to_ascii(value: &[u8]) -> String {
-    let s = unsafe{str::from_utf8_unchecked(value)};
+    let s = unsafe { str::from_utf8_unchecked(value) };
     json::encode(&s).unwrap()
 }
 
@@ -47,7 +47,7 @@ impl JSON {
         self.element_index = 0;
     }
 
-    fn end_key(&mut self) { }
+    fn end_key(&mut self) {}
 
     fn write_comma(&mut self) {
         if self.element_index > 0 {
@@ -94,8 +94,7 @@ impl Formatter for JSON {
         self.write_value(value);
     }
 
-    fn start_hash(&mut self, key: &[u8], length: u32,
-                  _expiry: Option<u64>, _info: EncodingType) {
+    fn start_hash(&mut self, key: &[u8], length: u32, _expiry: Option<u64>, _info: EncodingType) {
         self.start_key(length);
         self.write_key(key);
         write_str(&mut self.out, ":{");
@@ -116,8 +115,13 @@ impl Formatter for JSON {
         self.out.flush();
     }
 
-    fn start_set(&mut self, key: &[u8], cardinality: u32,
-                 _expiry: Option<u64>, _info: EncodingType) {
+    fn start_set(
+        &mut self,
+        key: &[u8],
+        cardinality: u32,
+        _expiry: Option<u64>,
+        _info: EncodingType,
+    ) {
         self.start_key(cardinality);
         self.write_key(key);
         write_str(&mut self.out, ":[");
@@ -134,8 +138,7 @@ impl Formatter for JSON {
         self.write_value(member);
     }
 
-    fn start_list(&mut self, key: &[u8], length: u32,
-                  _expiry: Option<u64>, _info: EncodingType) {
+    fn start_list(&mut self, key: &[u8], length: u32, _expiry: Option<u64>, _info: EncodingType) {
         self.start_key(length);
         self.write_key(key);
         write_str(&mut self.out, ":[");
@@ -151,8 +154,13 @@ impl Formatter for JSON {
         self.write_value(value);
     }
 
-    fn start_sorted_set(&mut self, key: &[u8], length: u32,
-                        _expiry: Option<u64>, _info: EncodingType) {
+    fn start_sorted_set(
+        &mut self,
+        key: &[u8],
+        length: u32,
+        _expiry: Option<u64>,
+        _info: EncodingType,
+    ) {
         self.start_key(length);
         self.write_key(key);
         write_str(&mut self.out, ":{");
@@ -163,8 +171,7 @@ impl Formatter for JSON {
         write_str(&mut self.out, "}");
     }
 
-    fn sorted_set_element(&mut self, _key: &[u8],
-                          score: f64, member: &[u8]) {
+    fn sorted_set_element(&mut self, _key: &[u8], score: f64, member: &[u8]) {
         self.write_comma();
         self.write_key(member);
         write_str(&mut self.out, ":");

src/formatter/mod.rs

@@ -1,18 +1,17 @@
 use std::io::Write;
 
+pub use self::json::JSON;
 pub use self::nil::Nil;
 pub use self::plain::Plain;
-pub use self::json::JSON;
 pub use self::protocol::Protocol;
 
 use super::types::EncodingType;
 
+pub mod json;
 pub mod nil;
 pub mod plain;
-pub mod json;
 pub mod protocol;
 
-
 pub fn write_str<W: Write>(out: &mut W, data: &str) {
     out.write(data.as_bytes()).unwrap();
 }
@@ -35,16 +34,23 @@ pub trait Formatter {
     fn end_hash(&mut self, key: &[u8]) {}
     fn hash_element(&mut self, key: &[u8], field: &[u8], value: &[u8]) {}
 
-
-    fn start_set(&mut self, key: &[u8], cardinality: u32, expiry: Option<u64>, info: EncodingType) {}
+    fn start_set(&mut self, key: &[u8], cardinality: u32, expiry: Option<u64>, info: EncodingType) {
+    }
     fn end_set(&mut self, key: &[u8]) {}
     fn set_element(&mut self, key: &[u8], member: &[u8]) {}
 
     fn start_list(&mut self, key: &[u8], length: u32, expiry: Option<u64>, info: EncodingType) {}
     fn end_list(&mut self, key: &[u8]) {}
     fn list_element(&mut self, key: &[u8], value: &[u8]) {}
 
-    fn start_sorted_set(&mut self, key: &[u8], length: u32, expiry: Option<u64>, info: EncodingType) {}
+    fn start_sorted_set(
+        &mut self,
+        key: &[u8],
+        length: u32,
+        expiry: Option<u64>,
+        info: EncodingType,
+    ) {
+    }
     fn end_sorted_set(&mut self, key: &[u8]) {}
     fn sorted_set_element(&mut self, key: &[u8], score: f64, member: &[u8]) {}
 }

src/formatter/nil.rs

@@ -1,4 +1,4 @@
-use formatter::Formatter;
+use crate::formatter::Formatter;
 
 pub struct Nil;
 

src/formatter/plain.rs

@@ -1,21 +1,25 @@
 #![allow(unused_must_use)]
-use formatter::Formatter;
+use super::write_str;
+use crate::formatter::Formatter;
+use crate::types::EncodingType;
+use serialize::hex::ToHex;
 use std::io;
 use std::io::Write;
-use serialize::hex::ToHex;
-use types::EncodingType;
-use super::write_str;
 
 pub struct Plain {
-    out: Box<Write+'static>,
+    out: Box<dyn Write + 'static>,
     dbnum: u32,
-    index: u32
+    index: u32,
 }
 
 impl Plain {
     pub fn new() -> Plain {
         let out = Box::new(io::stdout());
-        Plain { out: out, dbnum: 0, index: 0 }
+        Plain {
+            out: out,
+            dbnum: 0,
+            index: 0,
+        }
     }
 
     fn write_line_start(&mut self) {
@@ -76,8 +80,7 @@ impl Formatter for Plain {
         self.out.flush();
     }
 
-    fn start_list(&mut self, _key: &[u8], _length: u32,
-                  _expiry: Option<u64>, _info: EncodingType) {
+    fn start_list(&mut self, _key: &[u8], _length: u32, _expiry: Option<u64>, _info: EncodingType) {
         self.index = 0;
     }
     fn list_element(&mut self, key: &[u8], value: &[u8]) {
@@ -92,13 +95,17 @@ impl Formatter for Plain {
         self.index += 1;
     }
 
-    fn start_sorted_set(&mut self, _key: &[u8], _length: u32,
-                        _expiry: Option<u64>, _info: EncodingType) {
+    fn start_sorted_set(
+        &mut self,
+        _key: &[u8],
+        _length: u32,
+        _expiry: Option<u64>,
+        _info: EncodingType,
+    ) {
         self.index = 0;
     }
 
-    fn sorted_set_element(&mut self, key: &[u8],
-                          score: f64, member: &[u8]) {
+    fn sorted_set_element(&mut self, key: &[u8], score: f64, member: &[u8]) {
         self.write_line_start();
 
         self.out.write_all(key);