Merge pull request #130 from darrenldl/dev

Major upgrade (2.2.0 to 3.0.0)

.gitignore

@@ -12,3 +12,4 @@
 /tests/blkar
 /cov_tests/rsbx
 /cov_tests/blkar
+blkar

CHANGELOG.md

@@ -1,10 +1,10 @@
-## 2.3.0
+## 3.0.0
 
 - Changed decode mode to use only file portion of stored file name in SBX container
 
   - In previous versions, if the stored file name contains a path, then the entire path would be used, which can lead to unexpected output locations
 
-- Added `--multi-pass` flag to decode and sort mode
+- Added `--multi-pass` and `--multi-pass-no-skip` flag to decode and sort mode
 
   - This disables truncation, and allows updating the file gradually across multiple runs
 
@@ -16,6 +16,56 @@
 
   - Combined with the improved stats tracking allows checking if the container is sorted or not
 
+- Repalced `--to` with `--to-inc` and `--to-exc`
+
+  - This affects `rescue` and `show` mode
+
+- Added `--from`, `--to-inc` and `--to-exc` to the following modes
+
+  - check
+  - decode
+  - encode
+  - sort
+
+- Added `--ref-from`, `--ref-to-inc` and `--ref-to-exc` to the following modes
+
+  - check
+  - decode
+  - sort
+
+- Added `--force-misalign` to the following modes
+
+  - check
+  - decode
+  - sort
+
+- Updated reference block scanning code to respect `--force-misalign`
+
+- Updated burst error resistance level guessing to respect `--force-misalign`
+
+- Updated decode mode stats output
+
+  - This results in potentially incompatible JSON output
+
+- Fixed `misc_utils::calc_required_len_and_seek_to_from_byte_range`
+
+  - Sometimes off by one error occured
+
+- Ran `rustfmt` for code formatting
+
+- Ran `cargo fix --edition` to update to Rust 2018 edition
+
+- Fixed potential integer overflow issues in decode and repair mode
+
+  - Previously, when output is stdout, block index and seq num counter in decode mode may be incremented even if already at max
+  - Previously, seq num counter in repair mode may be incremented even if already at max
+
+- Updated burst error resistance level guessing code to respect `--from` and `--force-misalign` options
+
+- Fixed potential incorrect behaviour when processed block is incomplete
+
+  - Rectified by adding `#[must_use]` to `Reader::ReadResult`, forcing all code paths to check read result instead of possibly ignoring it
+
 ## 2.2.0
 
 - Added `--only-pick-uid` option to show mode

Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name    = "blkar"
-version = "2.3.0"
+version = "3.0.0"
 authors = ["Darren Ldl <darrenldldev@gmail.com>"]
+edition = "2018"
 build   = "build.rs"
 exclude = [
     "ci/*",

build.rs

@@ -44,25 +44,24 @@ use std::fs::File;
 use std::io::Write;
 use std::path::Path;
 
-const CRC_POLY_CCITT : u16 = 0x1021;
+const CRC_POLY_CCITT: u16 = 0x1021;
 
 fn make_crcccitt_tab() -> [u16; 256] {
-    let mut crc : u16;
-    let mut c : u16;
+    let mut crc: u16;
+    let mut c: u16;
 
-    let mut table : [u16; 256] = [0; 256];
+    let mut table: [u16; 256] = [0; 256];
 
     for i in 0u16..256u16 {
-
         crc = 0;
-        c   = i << 8;
+        c = i << 8;
 
         for _ in 0..8 {
-
             if ((crc ^ c) & 0x8000u16) != 0 {
-                crc = ( crc << 1 ) ^ CRC_POLY_CCITT; }
-            else {
-                crc =   crc << 1; }
+                crc = (crc << 1) ^ CRC_POLY_CCITT;
+            } else {
+                crc = crc << 1;
+            }
 
             c = c << 1;
         }

cov_tests/negative_params_tests.sh

@@ -19,7 +19,7 @@ for v in ${VALS[*]}; do
     echo "show using $v to"
     echo "========================================"
 
-    ./blkar show --to="$v" dummy.sbx
+    ./blkar show --to-exc="$v" dummy.sbx
 
     echo ""
 done

cov_tests/rescue_from_to_tests.sh

@@ -43,7 +43,7 @@ echo "Rescuing from dummy disk"
 
 echo -n "Checking that blkar only decodes first block"
 rm rescued_data/DEADBEEF* &>/dev/null
-output=$(kcov_blkar rescue --json dummy_empty_disk rescued_data --from 0 --to 511)
+output=$(kcov_blkar rescue --json dummy_empty_disk rescued_data --from 0 --to-inc 511)
 if [[ $(echo $output | jq -r ".error") != "null" ]]; then
     echo " ==> Invalid JSON"
     exit_code=1
@@ -63,7 +63,7 @@ fi
 
 echo -n "Checking that blkar only decodes second block"
 rm rescued_data/DEADBEEF* &>/dev/null
-output=$(kcov_blkar rescue --json dummy_empty_disk rescued_data --from 512 --to 512)
+output=$(kcov_blkar rescue --json dummy_empty_disk rescued_data --from 512 --to-inc 512)
 if [[ $(echo $output | jq -r ".error") != "null" ]]; then
     echo " ==> Invalid JSON"
     exit_code=1

src/block_preds.rs

@@ -3,10 +3,7 @@ macro_rules! block_pred_same_ver_uid {
         $block:expr
     ) => {{
         let version = $block.get_version();
-        let uid     = $block.get_uid();
-        move |block : &Block| -> bool {
-            block.get_version() == version
-                && block.get_uid() == uid
-        }
-    }}
+        let uid = $block.get_uid();
+        move |block: &Block| -> bool { block.get_version() == version && block.get_uid() == uid }
+    }};
 }