Implement object Id as newtype for more convenenience and…

…to cut extra dependencies to 'hex', which are now all handled
by the ID type.

Author: Byron

Cargo.lock

@@ -13,6 +13,5 @@ test = false
 
 [dependencies]
 git-odb = { version = "0.1.0", path = "../gitoxide-odb" }
-hex = "0.3.2"
 rayon = "1.3.0"
 anyhow = "1.0.31"

demos/Cargo.toml

@@ -34,8 +34,8 @@ fn run() -> Result<()> {
         index.kind(),
         index.num_objects(),
         index.version(),
-        hex::encode(index.checksum_of_index()),
-        hex::encode(index.checksum_of_pack()),
+        index.checksum_of_index(),
+        index.checksum_of_pack(),
     )?;
 
     let (deltas, commits, trees, blobs, tags) = index

demos/git-count.rs

@@ -5,7 +5,6 @@ use crate::borrowed::{
     Signature,
 };
 use bstr::{BStr, ByteSlice};
-use hex::FromHex;
 use nom::{
     branch::alt,
     bytes::{complete::is_not, complete::tag},
@@ -79,7 +78,7 @@ pub fn parse(i: &[u8]) -> IResult<&[u8], Commit, Error> {
 
 impl<'data> Commit<'data> {
     pub fn tree(&self) -> crate::Id {
-        <[u8; 20]>::from_hex(self.tree).expect("prior validation")
+        crate::Id::from_hex(self.tree).expect("prior validation")
     }
     pub fn from_bytes(d: &'data [u8]) -> Result<Commit<'data>, Error> {
         parse(d).map(|(_, t)| t).map_err(Error::from)

gitoxide-object/src/borrowed/commit.rs

@@ -4,7 +4,6 @@ use crate::borrowed::{
     Signature,
 };
 use bstr::{BStr, ByteSlice};
-use hex::FromHex;
 use nom::{
     branch::alt,
     bytes::complete::{tag, take_until, take_while1},
@@ -105,7 +104,7 @@ fn parse_message(i: &[u8]) -> IResult<&[u8], (&BStr, Option<&BStr>), Error> {
 
 impl<'data> Tag<'data> {
     pub fn target(&self) -> crate::Id {
-        <[u8; 20]>::from_hex(self.target).expect("prior validation")
+        crate::Id::from_hex(self.target).expect("prior validation")
     }
     pub fn from_bytes(d: &'data [u8]) -> Result<Tag<'data>, Error> {
         parse(d).map(|(_, t)| t).map_err(Error::from)

gitoxide-object/src/borrowed/tag.rs

@@ -1,3 +1,5 @@
+use bstr::ByteSlice;
+use nom::lib::std::fmt::Formatter;
 use quick_error::quick_error;
 
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
@@ -19,12 +21,36 @@ pub struct Time {
 pub const SHA1_SIZE: usize = 20;
 
 /// A SHA1 identifying objects
-pub type Id = [u8; SHA1_SIZE];
+#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
+pub struct Id(pub [u8; SHA1_SIZE]);
+
+impl Id {
+    pub fn encode_to_40_bytes_slice(&self, out: &mut [u8]) -> Result<(), hex::FromHexError> {
+        hex::encode_to_slice(self.0, out)
+    }
 
-pub fn id_from_20_bytes(b: &[u8]) -> Id {
-    let mut id = [0; SHA1_SIZE];
-    id.copy_from_slice(b);
-    id
+    pub fn from_20_bytes(b: &[u8]) -> Id {
+        let mut id = [0; SHA1_SIZE];
+        id.copy_from_slice(b);
+        Id(id)
+    }
+
+    pub fn from_hex(buf: &[u8]) -> Result<Id, hex::FromHexError> {
+        use hex::FromHex;
+        Ok(Id(<[u8; 20]>::from_hex(buf)?))
+    }
+
+    pub fn null() -> Id {
+        Id([0u8; 20])
+    }
+}
+
+impl std::fmt::Display for Id {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        let mut buf = [0u8; 40];
+        self.encode_to_40_bytes_slice(&mut buf).unwrap();
+        write!(f, "{}", &buf.as_bstr())
+    }
 }
 
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]

gitoxide-object/src/types.rs

@@ -1,7 +1,12 @@
 mod from_bytes {
-    use crate::{borrowed::fixture_bytes, hex_to_id};
+    use crate::borrowed::fixture_bytes;
     use bstr::ByteSlice;
     use git_object::borrowed::{Tree, TreeEntry as Entry, TreeMode as Mode};
+    use hex::FromHex;
+
+    pub fn hex_to_oid(hex: &str) -> [u8; 20] {
+        <[u8; 20]>::from_hex(hex).unwrap()
+    }
 
     #[test]
     fn everything() {
@@ -12,27 +17,27 @@ mod from_bytes {
                     Entry {
                         mode: Mode::BlobExecutable,
                         filename: b"exe".as_bstr(),
-                        oid: &hex_to_id("e69de29bb2d1d6434b8b29ae775ad8c2e48c5391")[..]
+                        oid: &hex_to_oid("e69de29bb2d1d6434b8b29ae775ad8c2e48c5391")[..]
                     },
                     Entry {
                         mode: Mode::Blob,
                         filename: b"file".as_bstr(),
-                        oid: &hex_to_id("e69de29bb2d1d6434b8b29ae775ad8c2e48c5391")[..]
+                        oid: &hex_to_oid("e69de29bb2d1d6434b8b29ae775ad8c2e48c5391")[..]
                     },
                     Entry {
                         mode: Mode::Commit,
                         filename: b"grit-submodule".as_bstr(),
-                        oid: &hex_to_id("b2d1b5d684bdfda5f922b466cc13d4ce2d635cf8")[..]
+                        oid: &hex_to_oid("b2d1b5d684bdfda5f922b466cc13d4ce2d635cf8")[..]
                     },
                     Entry {
                         mode: Mode::Tree,
                         filename: b"subdir".as_bstr(),
-                        oid: &hex_to_id("4d5fcadc293a348e88f777dc0920f11e7d71441c")[..]
+                        oid: &hex_to_oid("4d5fcadc293a348e88f777dc0920f11e7d71441c")[..]
                     },
                     Entry {
                         mode: Mode::Link,
                         filename: b"symlink".as_bstr(),
-                        oid: &hex_to_id("1a010b1c0f081b2e8901d55307a15c29ff30af0e")[..]
+                        oid: &hex_to_oid("1a010b1c0f081b2e8901d55307a15c29ff30af0e")[..]
                     }
                 ]
             }

gitoxide-object/tests/borrowed/tree.rs

@@ -1,10 +1,9 @@
-use hex::FromHex;
 use std::path::PathBuf;
 
 mod borrowed;
 
-pub fn hex_to_id(hex: &str) -> [u8; 20] {
-    <[u8; 20]>::from_hex(hex).unwrap()
+pub fn hex_to_id(hex: &str) -> git_object::Id {
+    git_object::Id::from_hex(hex.as_bytes()).unwrap()
 }
 
 pub fn fixture(path: &str) -> PathBuf {

gitoxide-object/tests/object.rs

@@ -11,7 +11,6 @@ doctest = false
 [dependencies]
 quick-error = "1.2.3"
 walkdir = "2.1.4"
-hex = "0.4.2"
 miniz_oxide = "0.3.6"
 smallvec = "1.3.0"
 filebuffer = "0.4.0"
@@ -22,3 +21,4 @@ btoi = "0.4.2"
 [dev-dependencies]
 pretty_assertions = "0.6.1"
 bstr = { version = "0.2.13", default-features = false, features = ["std"] }
+hex = "0.4.2"

gitoxide-odb/Cargo.toml

@@ -5,7 +5,6 @@ use crate::{
     loose::{Object, HEADER_READ_COMPRESSED_BYTES, HEADER_READ_UNCOMPRESSED_BYTES},
     zlib,
 };
-use hex::FromHex;
 use smallvec::SmallVec;
 use std::{fs, io::Cursor, io::Read, path::PathBuf};
 use walkdir::WalkDir;
@@ -66,9 +65,10 @@ pub fn parse_header(input: &[u8]) -> Result<(object::Kind, usize, usize), Error>
     }
 }
 
-fn sha1_path(id: &[u8; 20], mut root: PathBuf) -> PathBuf {
+fn sha1_path(id: &object::Id, mut root: PathBuf) -> PathBuf {
     let mut buf = [0u8; 40];
-    hex::encode_to_slice(id, &mut buf).expect("no failure as everything is preset by now");
+    id.encode_to_40_bytes_slice(&mut buf)
+        .expect("no failure as everything is preset by now");
     let buf = std::str::from_utf8(&buf).expect("ascii only in hex");
     root.push(&buf[..2]);
     root.push(&buf[2..]);
@@ -102,14 +102,14 @@ impl Db {
                                     first_byte.copy_from_slice(c1.as_bytes());
                                     rest.copy_from_slice(c2.as_bytes());
                                 }
-                                if let Ok(b) = <[u8; 20]>::from_hex(&buf[..]) {
+                                if let Ok(b) = object::Id::from_hex(&buf[..]) {
                                     is_valid_path = true;
                                     return b;
                                 }
                             }
                         }
                     }
-                    [0u8; 20]
+                    object::Id::null()
                 });
                 if is_valid_path {
                     Some(e)