Advance `gix-bitmap` to 'early' stage

Sebastian Thiel committed 3 years ago

Commit bdd505a1 parent 1f659273 files · +8 −5Browse files

Unified · Split

3 files

README.md +3 −3
gix-bitmap/src/ewah.rs +4 −0
gix-bitmap/src/lib.rs +1 −2

README.md+3−3

@@ -86,13 +86,13 @@ is usable to some extent. · 85 unmodified lines
86	86	* [gix-fs](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-fs)
87	87	* [gix-utils](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-utils)
88	88	* [gix-hashtable](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-hashtable)
89		− * `gitoxide-core`
90		−* very early _(possibly without any documentation and many rough edges)_
91	89	* [gix-worktree](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-worktree)
92	90	* [gix-bitmap](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-bitmap)
	91	+ * `gitoxide-core`
	92	+* very early _(possibly without any documentation and many rough edges)_
93	93	* [gix-date](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-date)
94		−* idea _(just a name placeholder)_
95	94	* [gix-archive](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-archive)
	95	+* idea _(just a name placeholder)_
96	96	* [gix-note](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-note)
97	97	* [gix-fetchhead](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-fetchhead)
98	98	* [gix-filter](https://github.com/Byron/gitoxide/blob/main/crate-status.md#gix-filter)

gix-bitmap/src/ewah.rs+4−0

@@ -1,13 +1,17 @@
1	1	use std::convert::TryInto;
2	2
	3	+///
3	4	pub mod decode {
	5	+ /// The error returned by [`decode()`][super::decode()].
4	6	#[derive(Debug, thiserror::Error)]
	7	+ #[allow(missing_docs)]
5	8	pub enum Error {
6	9	#[error("{}", message)]
7	10	Corrupt { message: &'static str },
8	11	}
9	12	}
10	13
	14	+/// Decode `data` as EWAH bitmap.
11	15	pub fn decode(data: &[u8]) -> Result<(Vec, &[u8]), decode::Error> {
12	16	use self::decode::Error;
13	17	use crate::decode;

gix-bitmap/src/lib.rs+1−2

@@ -1,8 +1,7 @@
1	1	//! An implementation of the shared parts of git bitmaps used in `gix-pack`, `gix-index` and `gix-worktree`.
2	2	//!
3	3	//! Note that many tests are performed indirectly by tests in the aforementioned consumer crates.
4		−#![deny(rust_2018_idioms, unsafe_code)]
5		−#![allow(missing_docs)]
	4	+#![deny(rust_2018_idioms, unsafe_code, missing_docs)]
6	5
7	6	/// Bitmap utilities for the advanced word-aligned hybrid bitmap
8	7	pub mod ewah;