Rename to_bstring to to_bstring_do_not_use

Author: cruessler

gix-object/src/tree/mod.rs

@@ -351,8 +351,11 @@ impl RepositoryPathPuf {
         self.inner.find_byte(byte)
     }
 
-    /// TODO
-    pub fn to_bstring(&self) -> BString {
+    /// 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 to_bstring_do_not_use(&self) -> BString {
         self.inner.clone()
     }
 }

gix-object/src/tree/write.rs

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

gix/src/object/tree/editor.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.to_bstring(),
+                    filename: entry.filename.to_bstring_do_not_use(),
                     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.to_bstring(),
+                        filename: entry.filename.to_bstring_do_not_use(),
                         kind: entry.mode.into(),
                         id: entry.oid,
                     });