[git-odb] refactor

Author: Byron

git-odb/src/lib.rs

@@ -20,13 +20,11 @@
 //!   * A database containing various [`compound::Backends`][store::compound::Backend] as gathered from `alternates` files.
 pub use git_pack as pack;
 pub use pack::{data, Find, FindExt};
-pub use write::Write;
-
-// TODO: leave it at 'git_odb::pack::data::Object` which is really what it is by now.
 
 ///
 pub mod store;
 
 pub mod alternate;
 ///
 pub mod write;
+pub use write::Write;

git-odb/src/store/compound/find.rs

@@ -9,7 +9,7 @@ use git_pack::data;
 #[allow(missing_docs)]
 pub enum Error {
     #[error("An error occurred while obtaining an object from the loose object store")]
-    Loose(#[from] loose::backend::find::Error),
+    Loose(#[from] loose::find::Error),
     #[error("An error occurred while obtaining an object from the packed object store")]
     Pack(#[from] pack::data::decode_entry::Error),
 }

git-odb/src/store/compound/write.rs

@@ -4,7 +4,7 @@ use crate::store::{compound, loose};
 use git_object::{mutable, Kind};
 
 impl crate::write::Write for compound::Backend {
-    type Error = loose::backend::write::Error;
+    type Error = loose::write::Error;
 
     fn write(&self, object: &mutable::Object, hash: git_hash::Kind) -> Result<git_hash::ObjectId, Self::Error> {
         self.loose.write(object, hash)

git-odb/src/store/linked/iter.rs

@@ -7,7 +7,7 @@ use crate::store::loose;
 #[allow(clippy::large_enum_variant)]
 enum DbState {
     Pack { pack_index: usize, entry_index: u32 },
-    Loose { iter: loose::backend::iter::Type },
+    Loose { iter: loose::iter::Type },
 }
 
 impl Default for DbState {
@@ -53,7 +53,7 @@ impl<Db> Iterator for AllObjects<Db>
 where
     Db: Borrow<linked::Db>,
 {
-    type Item = Result<ObjectId, loose::backend::iter::Error>;
+    type Item = Result<ObjectId, loose::iter::Error>;
 
     fn next(&mut self) -> Option<Self::Item> {
         let db = self.db.borrow();

git-odb/src/store/linked/write.rs

@@ -4,7 +4,7 @@ use std::io::Read;
 use crate::store::{linked, loose};
 
 impl crate::write::Write for linked::Db {
-    type Error = loose::backend::write::Error;
+    type Error = loose::write::Error;
 
     fn write(&self, object: &mutable::Object, hash: git_hash::Kind) -> Result<git_hash::ObjectId, Self::Error> {
         self.dbs[0].loose.write(object, hash)

git-odb/src/store/loose/backend/mod.rs

@@ -1,4 +1,4 @@
-use crate::store::loose::{backend::sha1_path, Backend, HEADER_READ_UNCOMPRESSED_BYTES};
+use crate::store::loose::{sha1_path, Backend, HEADER_READ_UNCOMPRESSED_BYTES};
 use git_features::zlib;
 use git_pack::{data, loose::object::header};
 use std::{convert::TryInto, fs, io::Read, path::PathBuf};

git-odb/src/store/loose/backend/find.rs renamed to git-odb/src/store/loose/find.rs

@@ -1,7 +1,41 @@
 //! An object database storing each object in a zlib compressed file with its hash in the path
 const HEADER_READ_UNCOMPRESSED_BYTES: usize = 512;
+use std::path::PathBuf;
 
+/// A database for reading and writing objects to disk, one file per object.
+pub struct Backend {
+    /// The directory in which objects are stored, containing 256 folders representing the hashes first byte.
+    pub path: PathBuf,
+}
+
+/// Initialization
+impl Backend {
+    /// Initialize the Db with the `objects_directory` containing the hexadecimal first byte subdirectories, which in turn
+    /// contain all loose objects.
+    ///
+    /// In a git repository, this would be `.git/objects`.
+    pub fn at(objects_directory: impl Into<PathBuf>) -> Backend {
+        Backend {
+            path: objects_directory.into(),
+        }
+    }
+}
+
+pub(crate) fn sha1_path(id: &git_hash::oid, mut root: PathBuf) -> PathBuf {
+    match id.kind() {
+        git_hash::Kind::Sha1 => {
+            let hex = id.to_sha1_hex();
+            let buf = std::str::from_utf8(&hex).expect("ascii only in hex");
+            root.push(&buf[..2]);
+            root.push(&buf[2..]);
+            root
+        }
+    }
+}
+
+///
+pub mod find;
+///
+pub mod iter;
 ///
-pub mod backend;
-#[doc(inline)]
-pub use backend::Backend;
+pub mod write;

git-odb/src/store/loose/backend/iter.rs renamed to git-odb/src/store/loose/iter.rs

@@ -105,7 +105,7 @@ impl Backend {
         hash::Write { hash, inner: file }: hash::Write<CompressedTempfile>,
     ) -> Result<git_hash::ObjectId, Error> {
         let id = git_hash::ObjectId::from(hash.digest());
-        let object_path = loose::backend::sha1_path(&id, self.path.clone());
+        let object_path = loose::sha1_path(&id, self.path.clone());
         let object_dir = object_path
             .parent()
             .expect("each object path has a 1 hex-bytes directory");