feat: Improve errors from try_deserialize

Enables user code to handle missing and invalid fields after calling
try_deserialize instead of having to match and search in the string
returned in `ConfigError::Message`.

Fixes #532

Author: barskern

src/error.rs

@@ -37,6 +37,34 @@ impl fmt::Display for Unexpected {
     }
 }
 
+impl From<de::Unexpected<'_>> for Unexpected {
+    fn from(value: de::Unexpected<'_>) -> Self {
+        match value {
+            de::Unexpected::Bool(b) => Self::Bool(b),
+            de::Unexpected::Unsigned(u) => Self::U64(u),
+            de::Unexpected::Signed(s) => Self::I64(s),
+            de::Unexpected::Float(f) => Self::Float(f),
+            de::Unexpected::Char(c) => Self::Str(c.into()),
+            de::Unexpected::Str(s) => Self::Str(s.into()),
+            de::Unexpected::Unit => Self::Unit,
+            de::Unexpected::Seq => Self::Seq,
+            de::Unexpected::Map => Self::Map,
+
+            // TODO Maybe add other items to unexpected if needed?
+            //de::Unexpected::Bytes(items) => todo!(),
+            //de::Unexpected::Option => todo!(),
+            //de::Unexpected::NewtypeStruct => todo!(),
+            //de::Unexpected::Enum => todo!(),
+            //de::Unexpected::UnitVariant => todo!(),
+            //de::Unexpected::NewtypeVariant => todo!(),
+            //de::Unexpected::TupleVariant => todo!(),
+            //de::Unexpected::StructVariant => todo!(),
+            //de::Unexpected::Other(_) => todo!(),
+            _ => Self::Unit,
+        }
+    }
+}
+
 /// Represents all possible errors that can occur when working with
 /// configuration.
 #[non_exhaustive]
@@ -289,6 +317,24 @@ impl de::Error for ConfigError {
     fn custom<T: fmt::Display>(msg: T) -> Self {
         Self::Message(msg.to_string())
     }
+
+    fn missing_field(field: &'static str) -> Self {
+        Self::NotFound(field.into())
+    }
+
+    fn invalid_type(unexp: de::Unexpected<'_>, exp: &dyn de::Expected) -> Self {
+        Self::Type {
+            origin: None,
+            unexpected: unexp.into(),
+            // TODO A better way of doing this? Maybe make "expected" a Cow<str>?
+            expected: exp.to_string().leak(),
+            key: None,
+        }
+    }
+
+    fn invalid_value(unexp: de::Unexpected<'_>, exp: &dyn de::Expected) -> Self {
+        <Self as de::Error>::invalid_type(unexp, exp)
+    }
 }
 
 impl ser::Error for ConfigError {

tests/testsuite/errors.rs

@@ -158,7 +158,7 @@ fn test_get_missing_field() {
     let res = c.get::<InnerSettings>("inner");
     assert_data_eq!(
         res.unwrap_err().to_string(),
-        str!["missing field `value2` for key `inner`"]
+        str![[r#"configuration property "value2" not found for key `inner`"#]]
     );
 }
 
@@ -184,7 +184,7 @@ fn test_get_missing_field_file() {
     let res = c.get::<InnerSettings>("inner");
     assert_data_eq!(
         res.unwrap_err().to_string(),
-        str!["missing field `value2` for key `inner`"]
+        str![[r#"configuration property "value2" not found for key `inner`"#]]
     );
 }
 
@@ -436,7 +436,7 @@ fn test_deserialize_missing_field() {
     let res = c.try_deserialize::<Settings>();
     assert_data_eq!(
         res.unwrap_err().to_string(),
-        str!["missing field `value2` for key `inner`"]
+        str![[r#"configuration property "inner.value2" not found"#]]
     );
 }
 
@@ -468,6 +468,6 @@ fn test_deserialize_missing_field_file() {
     let res = c.try_deserialize::<Settings>();
     assert_data_eq!(
         res.unwrap_err().to_string(),
-        str!["missing field `value2` for key `inner`"]
+        str![[r#"configuration property "inner.value2" not found"#]]
     );
 }

tests/testsuite/merge.rs

@@ -366,6 +366,6 @@ Settings {
     let res = cfg.try_deserialize::<Settings>();
     assert_data_eq!(
         res.unwrap_err().to_string(),
-        str!["invalid type: integer `42`, expected struct Profile for key `profile.int_to_non_empty`"]
+        str!["invalid type: 64-bit integer `42`, expected struct Profile for key `profile.int_to_non_empty`"]
     );
 }