Add git-bitmap crate for use in git-index (#293)

Author: Byron

Cargo.lock

@@ -115,6 +115,7 @@ members = [
     "git-diff",
     "git-traverse",
     "git-index",
+    "git-bitmap",
     "git-worktree",
     "git-packetline",
     "git-transport",

Cargo.toml

@@ -84,6 +84,7 @@ Follow linked crate name for detailed status. Please note that all crates follow
   * `gitoxide-core`
 * **very early**    
   * [git-index](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-index)
+  * [git-bitmap](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-bitmap)
 * **idea**
   * [git-worktree](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-worktree)
   * [git-tui](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-tui)

README.md

@@ -211,7 +211,18 @@ Check out the [performance discussion][git-traverse-performance] as well.
 * manage multiple worktrees
 * deal with exclude specifications, like .gitignore and other exclude files.
 
+### git-bitmap
+
+A plumbing crate with shared functionality regarding EWAH compressed bitmaps.
+
+* [ ] `Array` type to read and write bits
+* [ ] decode on-disk representation
+* [ ] encode on-disk representation
+
 ### git-index
+
+The git staging area.
+
 * read 
   * [x] V2
   * [x] V3

crate-status.md

@@ -19,6 +19,7 @@ echo "in root: gitoxide CLI"
 (enter cargo-smart-release && indent cargo diet -n --package-size-limit 85KB)
 (enter git-actor && indent cargo diet -n --package-size-limit 5KB)
 (enter git-index && indent cargo diet -n --package-size-limit 15KB)
+(enter git-bitmap && indent cargo diet -n --package-size-limit 5KB)
 (enter git-tempfile && indent cargo diet -n --package-size-limit 25KB)
 (enter git-lock && indent cargo diet -n --package-size-limit 15KB)
 (enter git-config && indent cargo diet -n --package-size-limit 65KB)

etc/check-package-size.sh

@@ -0,0 +1,20 @@
+[package]
+name = "git-bitmap"
+version = "0.0.0"
+repository = "https://github.com/Byron/gitoxide"
+license = "MIT/Apache-2.0"
+description = "A WIP crate of the gitoxide project dedicated implementing the standard git bitmap format"
+authors = ["Sebastian Thiel <sebastian.thiel@icloud.com>"]
+edition = "2021"
+
+[lib]
+doctest = false
+test = true
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+quick-error = "2.0.0"
+
+[dev-dependencies]
+git-testtools = { path = "../tests/tools"}

git-bitmap/Cargo.toml

@@ -0,0 +1,5 @@
+#![deny(unsafe_code, missing_docs, rust_2018_idioms)]
+#![allow(missing_docs, dead_code)]
+//! An implementation of the shared parts of git bitmaps used in `git-pack`, `git-index` and `git-worktree`.
+//!
+//! Note that many tests are performed indirectly by tests in the aforementioned consumer crates.