Promote file-format constants to `git_commitgraph::file` module.

This will let future code that writes commit graphs use those constants.

Conor Davis committed 5 years ago

Commit 0afd3541 parent b559dd03 files · +30 −28Browse files

Showing the changes to git-commitgraph/src (3 of 3 files). Show all

Unified · Split

3 files

git-commitgraph/src/file/commit.rs +1 −8
git-commitgraph/src/file/init.rs +5 −12
git-commitgraph/src/file/mod.rs +24 −8

 use git_hash::SIZE_OF_SHA1_DIGEST as SHA1_SIZE;
 use crate::{
-    file::{self, File},
+    file::{self, File, EXTENDED_EDGES_MASK, LAST_EXTENDED_EDGE_MASK, NO_PARENT},
     graph,
 };
     SecondParentWithoutFirstParent(git_hash::ObjectId),
 }
-// Note that git's commit-graph-format.txt as of v2.28.0 gives an incorrect value 0x0700_0000 for
-// NO_PARENT. Fixed in https://github.com/git/git/commit/4d515253afcef985e94400adbfed7044959f9121 .
-const NO_PARENT: u32 = 0x7000_0000;
-const EXTENDED_EDGES_MASK: u32 = 0x8000_0000;
 /// A commit as stored in a [`File`].
 pub struct Commit<'a> {
     file: &'a File,
     }
 }
-const LAST_EXTENDED_EDGE_MASK: u32 = 0x8000_0000;
 enum ExtraEdge {
     Internal(graph::Position),
     Last(graph::Position),

git-commitgraph/src/file/init.rs+5−12

@@ -9,9 +9,11 @@ use byteorder::{BigEndian, ByteOrder}; · 8 unmodified lines
9	use filebuffer::FileBuffer;	9	use filebuffer::FileBuffer;
10	use git_hash::SIZE_OF_SHA1_DIGEST as SHA1_SIZE;	10	use git_hash::SIZE_OF_SHA1_DIGEST as SHA1_SIZE;
11		11
12	use crate::file::{File, COMMIT_DATA_ENTRY_SIZE, FAN_LEN, SIGNATURE};	12	use crate::file::{
13		13	ChunkId, File, BASE_GRAPHS_LIST_CHUNK_ID, CHUNK_LOOKUP_SIZE, COMMIT_DATA_CHUNK_ID, COMMIT_DATA_ENTRY_SIZE,
14	type ChunkId = [u8; 4];	14	EXTENDED_EDGES_LIST_CHUNK_ID, FAN_LEN, HEADER_LEN, OID_FAN_CHUNK_ID, OID_LOOKUP_CHUNK_ID, OID_LOOKUP_ENTRY_SIZE,
		15	SENTINEL_CHUNK_ID, SIGNATURE,
		16	};
15		17
16	/// The error used in [`File::at()`].	18	/// The error used in [`File::at()`].
17	#[derive(thiserror::Error, Debug)]	19	#[derive(thiserror::Error, Debug)]
@@ -51,20 +53,11 @@ pub enum Error { · 33 unmodified lines
51	UnsupportedVersion(u8),	53	UnsupportedVersion(u8),
52	}	54	}
53		55
54	const CHUNK_LOOKUP_SIZE: usize = 12;
55	const HEADER_LEN: usize = 8;
56	const TRAILER_LEN: usize = SHA1_SIZE;	56	const TRAILER_LEN: usize = SHA1_SIZE;
57	const MIN_FILE_SIZE: usize = HEADER_LEN + ((MIN_CHUNKS + 1) * CHUNK_LOOKUP_SIZE) + TRAILER_LEN;	57	const MIN_FILE_SIZE: usize = HEADER_LEN + ((MIN_CHUNKS + 1) * CHUNK_LOOKUP_SIZE) + TRAILER_LEN;
58	const OID_LOOKUP_ENTRY_SIZE: usize = SHA1_SIZE;
59		58
60	// Required chunks: OIDF, OIDL, CDAT	59	// Required chunks: OIDF, OIDL, CDAT
61	const MIN_CHUNKS: usize = 3;	60	const MIN_CHUNKS: usize = 3;
62	const BASE_GRAPHS_LIST_CHUNK_ID: ChunkId = *b"BASE";
63	const COMMIT_DATA_CHUNK_ID: ChunkId = *b"CDAT";
64	const EXTENDED_EDGES_LIST_CHUNK_ID: ChunkId = *b"EDGE";
65	const OID_FAN_CHUNK_ID: ChunkId = *b"OIDF";
66	const OID_LOOKUP_CHUNK_ID: ChunkId = *b"OIDL";
67	const SENTINEL_CHUNK_ID: ChunkId = [0u8; 4];
68		61
69	impl File {	62	impl File {
70	/// Try to parse the commit graph file at `path`.	63	/// Try to parse the commit graph file at `path`.

git-commitgraph/src/file/mod.rs+24−8

 //! Operations on a single commit-graph file.
-mod access;
+pub use self::{commit::Commit, init::Error};
-pub mod commit;
-pub use commit::Commit;
-mod init;
-pub mod verify;
 use std::{
     fmt::{Display, Formatter},
 use filebuffer::FileBuffer;
 use git_hash::SIZE_OF_SHA1_DIGEST as SHA1_SIZE;
-pub use init::Error;
+mod access;
+pub mod commit;
+mod init;
+pub mod verify;
+const CHUNK_LOOKUP_SIZE: usize = 12;
 const COMMIT_DATA_ENTRY_SIZE: usize = SHA1_SIZE + 16;
 const FAN_LEN: usize = 256;
+const HEADER_LEN: usize = 8;
+const OID_LOOKUP_ENTRY_SIZE: usize = SHA1_SIZE;
 const SIGNATURE: &[u8] = b"CGPH";
+type ChunkId = [u8; 4];
+const BASE_GRAPHS_LIST_CHUNK_ID: ChunkId = *b"BASE";
+const COMMIT_DATA_CHUNK_ID: ChunkId = *b"CDAT";
+const EXTENDED_EDGES_LIST_CHUNK_ID: ChunkId = *b"EDGE";
+const OID_FAN_CHUNK_ID: ChunkId = *b"OIDF";
+const OID_LOOKUP_CHUNK_ID: ChunkId = *b"OIDL";
+const SENTINEL_CHUNK_ID: ChunkId = [0u8; 4];
+// Note that git's commit-graph-format.txt as of v2.28.0 gives an incorrect value 0x0700_0000 for
+// NO_PARENT. Fixed in https://github.com/git/git/commit/4d515253afcef985e94400adbfed7044959f9121 .
+const NO_PARENT: u32 = 0x7000_0000;
+const EXTENDED_EDGES_MASK: u32 = 0x8000_0000;
+const LAST_EXTENDED_EDGE_MASK: u32 = 0x8000_0000;
 /// A single commit-graph file.
 ///
 /// All operations on a `File` are local to that graph file. Since a commit graph can span multiple

Promote file-format constants to `git_commitgraph::file` module.

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code