use std::convert::TryFrom instead of a custom function

mirosval · Feb 28, 2023 · d8df964 · d8df964
1 parent d74c968
commit d8df964
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -16,15 +16,15 @@ fn is_positive(i: i32) -> Result<i32, String> {
   }
 }
 
-// 3. Derive (1) the `unvalidated` type and a `from_unvalidated` function
+// 3. Derive (1) the `unvalidated` type and a `std::convert::TryFrom` trait
 #[derive(Validated)]
 // 2. And a struct 
 struct A {
   a: i32,
 }
 let i: i32 = 1;
 // 4. Construct the instance of the original type from the unvalidated version
-let a = A::from_unvalidated(UnvalidatedA { a: i }).expect("valid instance");
+let a = A::try_from(UnvalidatedA { a: i }).expect("valid instance");
 assert_eq!(a.a, i);
 ```
 

diff --git a/tests/integration_test.rs b/tests/integration_test.rs
@@ -35,7 +35,7 @@ fn test_no_validated_fields() {
         a: i32,
     }
     let i: i32 = 1;
-    let a = A::from_unvalidated(UnvalidatedA { a: i }).expect("valid instance");
+    let a = A::try_from(UnvalidatedA { a: i }).expect("valid instance");
     assert_eq!(a.a, i);
 }
 
@@ -47,7 +47,7 @@ fn test_one_validated_field() {
         a: i32,
     }
     let a: i32 = 1;
-    let instance = A::from_unvalidated(UnvalidatedA { a }).expect("valid instance");
+    let instance = A::try_from(UnvalidatedA { a }).expect("valid instance");
     assert_eq!(instance.a, a);
 }
 
@@ -62,7 +62,7 @@ fn test_one_validated_one_not_validated_field() {
     }
     let a: i32 = 1;
     let b: u8 = 2;
-    let instance = A::from_unvalidated(UnvalidatedA { a, _b: b }).expect("valid instance");
+    let instance = A::try_from(UnvalidatedA { a, _b: b }).expect("valid instance");
     assert_eq!(instance.a, a);
     assert_eq!(instance._b, b);
 }
@@ -75,7 +75,7 @@ fn test_lifetime() {
         a: &'a str,
     }
     let a: &str = "aaa";
-    let instance = A::from_unvalidated(UnvalidatedA { a }).expect("valid instance");
+    let instance = A::try_from(UnvalidatedA { a }).expect("valid instance");
     assert_eq!(instance.a, a);
 }
 
@@ -89,7 +89,7 @@ fn test_generics() {
     }
     let a: i32 = 1;
     let b: u8 = 2;
-    let instance = A::from_unvalidated(UnvalidatedA { a, _b: b }).expect("valid instance");
+    let instance = A::try_from(UnvalidatedA { a, _b: b }).expect("valid instance");
     assert_eq!(instance.a, a);
     assert_eq!(instance._b, b);
 }
diff --git a/tests/ui/wrong_validator_type.rs b/tests/ui/wrong_validator_type.rs
@@ -23,6 +23,6 @@ struct A {
 fn main() {
     let a: i32 = 1;
     // This should fail, because validator error type does not match the defined custom error type
-    let instance = A::from_unvalidated(UnvalidatedA { a }).expect("valid instance");
+    let instance = A::try_from(UnvalidatedA { a }).expect("valid instance");
     assert_eq!(instance.a, a);
 }
diff --git a/valibuk_core/src/lib.rs b/valibuk_core/src/lib.rs
@@ -75,10 +75,9 @@ mod tests {
             struct UnvalidatedA {
                 pub a: i32,
             }
-            impl A {
-                pub fn from_unvalidated(
-                    unvalidated: UnvalidatedA,
-                ) -> ::core::result::Result<A, Vec<::std::string::String>> {
+            impl ::std::convert::TryFrom<UnvalidatedA> for A {
+                type Error = ::std::vec::Vec<::std::string::String>;
+                fn try_from(unvalidated: UnvalidatedA) -> ::core::result::Result<Self, Self::Error> {
                     Ok(A { a: unvalidated.a })
                 }
             }
@@ -99,10 +98,9 @@ mod tests {
             struct UnvalidatedA {
                 pub a: i32,
             }
-            impl A {
-                pub fn from_unvalidated(
-                    unvalidated: UnvalidatedA,
-                ) -> ::core::result::Result<A, Vec<E>> {
+            impl ::std::convert::TryFrom<UnvalidatedA> for A {
+                type Error = ::std::vec::Vec<E>;
+                fn try_from(unvalidated: UnvalidatedA) -> ::core::result::Result<Self, Self::Error> {
                     Ok(A { a: unvalidated.a })
                 }
             }
@@ -122,10 +120,9 @@ mod tests {
             struct UnvalidatedA<'a> {
                 pub a: &'a str
             }
-            impl<'a> A<'a> {
-                pub fn from_unvalidated(
-                    unvalidated: UnvalidatedA<'a>,
-                    ) -> ::core::result::Result<A<'a>, Vec<::std::string::String>> {
+            impl<'a> ::std::convert::TryFrom<UnvalidatedA<'a>> for A<'a> {
+                type Error = ::std::vec::Vec<::std::string::String>;
+                fn try_from(unvalidated: UnvalidatedA<'a>) -> ::core::result::Result<Self, Self::Error> {
                     Ok(A { a: unvalidated.a })
                 }
             }

diff --git a/valibuk_core/src/root.rs b/valibuk_core/src/root.rs
@@ -120,10 +120,12 @@ impl<'a> ValidatedDeriv<'a> {
             }
         };
         Ok(quote! {
-            impl #impl_generics #name #ty_generics {
-                pub fn from_unvalidated(
+            impl #impl_generics ::std::convert::TryFrom<#unvalidated_name #ty_generics>  for #name #ty_generics {
+                type Error = ::std::vec::Vec<#ety>;
+
+                fn try_from(
                     unvalidated: #unvalidated_name #ty_generics
-                ) -> ::core::result::Result<#name #ty_generics, Vec<#ety>> {
+                ) -> ::core::result::Result<Self, Self::Error> {
                     #body
                 }
             }