Replace From by TryFrom

Author: cruessler

gix-object/src/object/convert.rs

@@ -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().into(),
+            filename: filename.to_owned().try_into().expect("TODO"),
             oid: oid.into(),
         }
     }

gix-object/src/tree/editor.rs

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

gix-object/src/tree/mod.rs

@@ -378,21 +378,41 @@ impl std::ops::Index<std::ops::RangeTo<usize>> for RepositoryPathPuf {
     }
 }
 
-impl From<&str> for RepositoryPathPuf {
-    fn from(value: &str) -> Self {
-        Self { inner: value.into() }
+///
+pub mod repository_path_buf {
+    /// The error used in [`RepositoryPathPuf`](super::RepositoryPathPuf).
+    #[derive(Debug, thiserror::Error)]
+    #[allow(missing_docs)]
+    pub enum Error {}
+}
+
+impl TryFrom<&str> for RepositoryPathPuf {
+    type Error = repository_path_buf::Error;
+
+    fn try_from(value: &str) -> Result<Self, Self::Error> {
+        // TODO
+        // Check whether the documented constraints are met, return `Err` if not.
+        Ok(Self { inner: value.into() })
     }
 }
 
-impl From<&BStr> for RepositoryPathPuf {
-    fn from(value: &BStr) -> Self {
-        Self { inner: value.into() }
+impl TryFrom<&BStr> for RepositoryPathPuf {
+    type Error = repository_path_buf::Error;
+
+    fn try_from(value: &BStr) -> Result<Self, Self::Error> {
+        // TODO
+        // Check whether the documented constraints are met, return `Err` if not.
+        Ok(Self { inner: value.into() })
     }
 }
 
-impl From<BString> for RepositoryPathPuf {
-    fn from(value: BString) -> Self {
-        Self { inner: value }
+impl TryFrom<BString> for RepositoryPathPuf {
+    type Error = repository_path_buf::Error;
+
+    fn try_from(value: BString) -> Result<Self, Self::Error> {
+        // TODO
+        // Check whether the documented constraints are met, return `Err` if not.
+        Ok(Self { inner: value })
     }
 }
 

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

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

gix-object/tests/object/tree/editor.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".into(),
+            filename: "empty-dir-via-cursor".try_into().expect("TODO"),
             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".into(),
+            filename: "path".try_into().expect("TODO"),
             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".into(),
+            filename: "b".try_into().expect("TODO"),
             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".into(),
+            filename: "c".try_into().expect("TODO"),
             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".into(),
+            filename: "a".try_into().expect("TODO"),
             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/iter.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.into(),
+                filename: filename.try_into().ok()?,
                 oid,
             })
         }

gix-odb/tests/odb/memory.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".into(),
+        filename: "z-for-sorting_another-file-with-same-content".try_into().expect("TODO"),
         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".into(),
+        filename: "z-for-sorting_another-file-with-same-content".try_into().expect("TODO"),
         oid: existing,
     });
     let new_tree_id = odb.write(&tree)?;

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

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