Remove RepositoryPathBuf as there is no use for it currently.

One day the Entry could be more strongly typed to indicate it's
a valid component, while leaving `EntryRef` to point to whatever
was read, even if it's invalid.

Author: Byron

Cargo.lock

@@ -49,7 +49,6 @@ gix-hashtable = { version = "^0.8.0", path = "../gix-hashtable" }
 gix-validate = { version = "^0.9.4", path = "../gix-validate" }
 gix-actor = { version = "^0.34.0", path = "../gix-actor" }
 gix-date = { version = "^0.9.4", path = "../gix-date" }
-gix-fs = { version = "^0.14.0", path = "../gix-fs" }
 gix-path = { version = "^0.10.15", path = "../gix-path" }
 gix-utils = { version = "^0.2.0", path = "../gix-utils" }
 

gix-object/Cargo.toml

@@ -72,7 +72,7 @@ impl From<tree::EntryRef<'_>> for tree::Entry {
         let tree::EntryRef { mode, filename, oid } = other;
         tree::Entry {
             mode,
-            filename: filename.to_owned().try_into().expect("TODO"),
+            filename: filename.to_owned(),
             oid: oid.into(),
         }
     }

gix-object/src/object/convert.rs

@@ -33,8 +33,6 @@ pub enum Error {
     EmptyPathComponent,
     #[error(transparent)]
     FindExistingObject(#[from] crate::find::existing_object::Error),
-    #[error(transparent)]
-    RepositoryPathBuf(#[from] crate::tree::repository_path_buf::Error),
 }
 
 /// Lifecycle
@@ -326,7 +324,7 @@ impl Editor<'_> {
                         cursor.entries.insert(
                             insertion_idx,
                             tree::Entry {
-                                filename: name.try_into()?,
+                                filename: name.into(),
                                 mode: if is_last { kind.into() } else { EntryKind::Tree.into() },
                                 oid: if is_last { id } else { id.kind().null() },
                             },

gix-object/src/tree/editor.rs

@@ -1,6 +1,3 @@
-use bstr::ByteSlice;
-use gix_fs::stack::ToNormalPathComponents;
-
 use crate::{
     bstr::{BStr, BString},
     tree, Tree, TreeRef,
@@ -326,131 +323,14 @@ impl Ord for EntryRef<'_> {
     }
 }
 
-/// A wrapper for `BString`. It is used to enforce the following constraints:
-///
-/// - The path separator always is `/`, independent of the platform.
-/// - Only normal components are allowed.
-/// - It is always represented as a bunch of bytes.
-#[derive(Clone, Debug, Eq, PartialEq, Hash)]
-#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
-pub struct RepositoryPathPuf {
-    inner: BString,
-}
-
-impl RepositoryPathPuf {
-    fn len(&self) -> usize {
-        self.inner.len()
-    }
-
-    fn get(&self, index: usize) -> std::option::Option<&u8> {
-        self.inner.get(index)
-    }
-
-    fn find_byte(&self, byte: u8) -> std::option::Option<usize> {
-        self.inner.find_byte(byte)
-    }
-
-    /// Do not use this method.
-    ///
-    /// This method is intended to be used during the transition from `BString` to
-    /// `RepositoryPathBuf` as long as there are APIs that expect the former instead of the latter.
-    pub fn into_bstring_do_not_use(self) -> BString {
-        self.inner
-    }
-}
-
-impl std::fmt::Display for RepositoryPathPuf {
-    #[inline]
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        self.inner.fmt(f)
-    }
-}
-
-impl std::ops::Index<std::ops::RangeTo<usize>> for RepositoryPathPuf {
-    type Output = BStr;
-
-    #[inline]
-    fn index(&self, r: std::ops::RangeTo<usize>) -> &BStr {
-        use bstr::ByteSlice;
-
-        BStr::new(&self.inner.as_bytes()[..r.end])
-    }
-}
-
-///
-pub mod repository_path_buf {
-    use gix_fs::stack::to_normal_path_components;
-
-    /// The error used in [`RepositoryPathPuf`](super::RepositoryPathPuf).
-    #[derive(Debug, thiserror::Error)]
-    #[allow(missing_docs)]
-    pub enum Error {
-        #[error(transparent)]
-        ContainsNonNormalComponents(#[from] to_normal_path_components::Error),
-        #[error(transparent)]
-        IllegalUtf8(#[from] gix_path::Utf8Error),
-    }
-}
-
-impl TryFrom<&str> for RepositoryPathPuf {
-    type Error = repository_path_buf::Error;
-
-    fn try_from(value: &str) -> Result<Self, Self::Error> {
-        let path = std::path::Path::new(value);
-
-        for component in path.to_normal_path_components() {
-            component?;
-        }
-
-        Ok(Self { inner: value.into() })
-    }
-}
-
-impl TryFrom<&BStr> for RepositoryPathPuf {
-    type Error = repository_path_buf::Error;
-
-    fn try_from(value: &BStr) -> Result<Self, Self::Error> {
-        let path: &std::path::Path = &gix_path::try_from_bstr(value)?;
-
-        for component in path.to_normal_path_components() {
-            component?;
-        }
-
-        Ok(Self { inner: value.into() })
-    }
-}
-
-impl TryFrom<BString> for RepositoryPathPuf {
-    type Error = repository_path_buf::Error;
-
-    fn try_from(value: BString) -> Result<Self, Self::Error> {
-        let path: &std::path::Path = &gix_path::try_from_bstr(&value)?;
-
-        for component in path.to_normal_path_components() {
-            component?;
-        }
-
-        Ok(Self { inner: value })
-    }
-}
-
-impl std::ops::Deref for RepositoryPathPuf {
-    type Target = [u8];
-
-    #[inline]
-    fn deref(&self) -> &[u8] {
-        &self.inner
-    }
-}
-
 /// An entry in a [`Tree`], similar to an entry in a directory.
 #[derive(PartialEq, Eq, Debug, Hash, Clone)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Entry {
     /// The kind of object to which `oid` is pointing to.
     pub mode: EntryMode,
     /// The name of the file in the parent tree.
-    pub filename: RepositoryPathPuf,
+    pub filename: BString,
     /// The id of the object representing the entry.
     pub oid: gix_hash::ObjectId,
 }

gix-object/src/tree/mod.rs

@@ -42,7 +42,7 @@ impl crate::WriteTo for Tree {
 
             if filename.find_byte(0).is_some() {
                 return Err(Error::NullbyteInFilename {
-                    name: filename.clone().into_bstring_do_not_use(),
+                    name: (*filename).to_owned(),
                 }
                 .into());
             }

gix-object/src/tree/write.rs

@@ -111,12 +111,12 @@ mod tree {
         let mut tree = gix_object::Tree::empty();
         tree.entries.push(tree::Entry {
             mode: EntryKind::Blob.into(),
-            filename: "".try_into().expect("TODO"),
+            filename: "".into(),
             oid: gix_hash::Kind::Sha1.null(),
         });
         tree.entries.push(tree::Entry {
             mode: EntryKind::Tree.into(),
-            filename: "something\nwith\newlines\n".try_into().expect("TODO"),
+            filename: "something\nwith\newlines\n".into(),
             oid: gix_hash::ObjectId::empty_tree(gix_hash::Kind::Sha1),
         });
         tree.write_to(&mut std::io::sink())
@@ -128,7 +128,7 @@ mod tree {
         let mut tree = gix_object::Tree::empty();
         tree.entries.push(tree::Entry {
             mode: EntryKind::Blob.into(),
-            filename: "hi\0ho".try_into().expect("TODO"),
+            filename: "hi\0ho".into(),
             oid: gix_hash::Kind::Sha1.null(),
         });
         let err = tree.write_to(&mut std::io::sink()).unwrap_err();

gix-object/tests/object/encode/mod.rs

@@ -41,7 +41,7 @@ fn from_empty_cursor() -> crate::Result {
         cursor.get(Some("empty-dir-via-cursor")),
         Some(&Entry {
             mode: EntryKind::Tree.into(),
-            filename: "empty-dir-via-cursor".try_into().expect("TODO"),
+            filename: "empty-dir-via-cursor".into(),
             oid: gix_hash::ObjectId::empty_tree(gix_hash::Kind::Sha1),
         }),
     );
@@ -69,7 +69,7 @@ fn from_empty_cursor() -> crate::Result {
         edit.get(["some", "deeply", "nested", "path"]),
         Some(&Entry {
             mode: EntryKind::Tree.into(),
-            filename: "path".try_into().expect("TODO"),
+            filename: "path".into(),
             oid: gix_hash::Kind::Sha1.null(),
         }),
         "the directory leading to the removed one is still present"
@@ -470,7 +470,7 @@ fn from_empty_add() -> crate::Result {
         edit.get(["a", "b"]),
         Some(&Entry {
             mode: EntryKind::Tree.into(),
-            filename: "b".try_into().expect("TODO"),
+            filename: "b".into(),
             oid: hex_to_id("4b825dc642cb6eb9a060e54bf8d69288fbee4904"),
         }),
         "before writing, entries are still present, just like they were written"
@@ -479,7 +479,7 @@ fn from_empty_add() -> crate::Result {
         edit.get(["a", "b", "c"]),
         Some(&Entry {
             mode: EntryKind::Tree.into(),
-            filename: "c".try_into().expect("TODO"),
+            filename: "c".into(),
             oid: gix_hash::ObjectId::empty_tree(gix_hash::Kind::Sha1),
         }),
     );
@@ -503,7 +503,7 @@ fn from_empty_add() -> crate::Result {
         edit.get(Some("a")),
         Some(&Entry {
             mode: EntryKind::Tree.into(),
-            filename: "a".try_into().expect("TODO"),
+            filename: "a".into(),
             oid: hex_to_id("850bf83c26003cb0541318718bc9217c4a5bde6d"),
         }),
         "but the top-level tree is still available and can yield its entries, as written with proper ids"

gix-object/tests/object/tree/editor.rs

@@ -124,7 +124,7 @@ mod lookup_entry {
         pub(super) fn entry(filename: &str, mode: tree::EntryKind, oid: gix_hash::ObjectId) -> Option<tree::Entry> {
             Some(tree::Entry {
                 mode: mode.into(),
-                filename: filename.try_into().ok()?,
+                filename: filename.into(),
                 oid,
             })
         }

gix-object/tests/object/tree/iter.rs

@@ -19,7 +19,7 @@ fn without_memory() -> crate::Result {
     let mut tree = tree.to_owned();
     tree.entries.push(tree::Entry {
         mode: tree::EntryKind::Blob.into(),
-        filename: "z-for-sorting_another-file-with-same-content".try_into().expect("TODO"),
+        filename: "z-for-sorting_another-file-with-same-content".into(),
         oid: existing,
     });
     let new_tree_id = odb.write(&tree)?;
@@ -62,7 +62,7 @@ fn with_memory() -> crate::Result {
     let mut tree = tree.to_owned();
     tree.entries.push(tree::Entry {
         mode: tree::EntryKind::Blob.into(),
-        filename: "z-for-sorting_another-file-with-same-content".try_into().expect("TODO"),
+        filename: "z-for-sorting_another-file-with-same-content".into(),
         oid: existing,
     });
     let new_tree_id = odb.write(&tree)?;

gix-odb/tests/odb/memory.rs

@@ -32,7 +32,7 @@ fn main() -> anyhow::Result<()> {
         let entry = tree::Entry {
             mode: tree::EntryKind::Blob.into(),
             oid: blob_id,
-            filename: "hello.txt".try_into()?,
+            filename: "hello.txt".into(),
         };
 
         tree.entries.push(entry);

gix/examples/init-repo-and-commit.rs

@@ -288,14 +288,14 @@ fn write_cursor<'repo>(cursor: &mut Cursor<'_, 'repo>) -> Result<Id<'repo>, writ
                     cursor.validate,
                 )
                 .map_err(|err| write::Error::InvalidFilename {
-                    filename: entry.filename.clone().into_bstring_do_not_use(),
+                    filename: entry.filename.clone(),
                     kind: entry.mode.into(),
                     id: entry.oid,
                     source: err,
                 })?;
                 if !entry.mode.is_commit() && !cursor.repo.has_object(entry.oid) {
                     return Err(write::Error::MissingObject {
-                        filename: entry.filename.clone().into_bstring_do_not_use(),
+                        filename: entry.filename.clone(),
                         kind: entry.mode.into(),
                         id: entry.oid,
                     });