bump to 0.2.2

olekspickle · Feb 1, 2024 · 3a3331c · 3a3331c
1 parent 31893ef
commit 3a3331c
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 4 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "serde_default_utils"
 authors = ["Oleks Pickle <[email protected]>"]
-version = "0.2.1"
+version = "0.2.2"
 edition = "2021"
 categories = ["encoding", "no-std", "no-std::no-alloc"]
 description = "A set of simple helper functions to cut corners with serde_default"

diff --git a/README.md b/README.md
@@ -8,15 +8,31 @@ Based on [const generic parameters](https://doc.rust-lang.org/reference/items/ge
 Heavily inspired by discussions on issues about serde defaults, but mostly [this one](https://github.com/serde-rs/serde/issues/368)
 
 ## Kudos
-This is just a @JohnTheCoolingFan's proposed solution but available as crate and a macro that
+- JohnTheCoolingFan posted this solution, I just made it available as crate and a macro that
 helps to generate another const generic function for any const generic type.
+- bytedream         made a more powerful version of it, and although I still see const generic approach as more readable,
+I have to admit that for strings it's superior, hence - included under the feature
+
 
 ## Example
 ```rust
     use serde_default_utils::*;
     use serde::{Deserialize, Serialize};
 
-    const JSON: &str = r#"{"yes_or_no":false,"max":60,"delta":-77,"delimeter":"☀","motto":"You matter"}"#;
+        const JSON: &str =
+            r#"{
+                "yes_or_no":false,
+                "max":60,
+                "delta":-77,
+                "delimeter":"☀",
+                "motto":"I matter"
+            }"#;
+        const INLINE_JSON: &str =
+            r#"{
+                "inline_motto":"I matter even more",
+                "slice":["I", "matter", "even", "more"],
+                "slice_u64":[9000, 8000, 10000, 7000]
+            }"#;
     const EMPTY_JSON: &str = r#"{}"#;
     const MAX: u32 = 7;
 
@@ -37,11 +53,23 @@ helps to generate another const generic function for any const generic type.
         motto: &'static str,
     }
 
+    #[cfg(feature = "inline")]
+    #[serde_inline_default]
+    #[derive(Serialize, Deserialize, Default)]
+    struct InlineConfig {
+        #[serde_inline_default("You matter even more".to_string())]
+        inline_motto: String,
+        #[serde_inline_default(vec!["You", "matter", "even", "more"])]
+        slice: Vec<&'static str>,
+        #[serde_inline_default(vec![98712, 12346, 129389, 102937])]
+        slice_u64: Vec<u64>,
+    }
+
     fn main() {
         // existing json fields are not changed
         let config: Config = serde_json::from_str(JSON).unwrap();
         let s = serde_json::to_string(&config).unwrap();
-        assert_eq!(r#"{"yes_or_no":false,"delta":-77,"max":60,"delimeter":"☀","motto":"You matter"}"#, &s);
+        assert_eq!(r#"{"yes_or_no":false,"delta":-77,"max":60,"delimeter":"☀","motto":"I matter"}"#, &s);
         // if the field is not present - it is substituted with defaults
         let config: Config = serde_json::from_str(EMPTY_JSON).unwrap();
         let s = serde_json::to_string(&config).unwrap();
@@ -50,6 +78,23 @@ helps to generate another const generic function for any const generic type.
         let config = Config::default();
         let s = serde_json::to_string(&config).unwrap();
         assert_eq!(r#"{"yes_or_no":false,"delta":0,"max":0,"delimeter":"\u0000","motto":""}"#, &s);
+
+        // Inline
+        #[cfg(feature = "inline")]
+        {
+        // existing json fields are not changed
+        let config: InlineConfig = serde_json::from_str(INLINE_JSON).unwrap();
+        let s = serde_json::to_string(&config).unwrap();
+        assert_eq!(r#"{"inline_motto":"I matter even more","slice":["I","matter","even","more"],"slice_u64":[9000,8000,10000,7000]}"#, &s);
+        // if the field is not present - it is substituted with defaults
+        let config: InlineConfig = serde_json::from_str(EMPTY_JSON).unwrap();
+        let s = serde_json::to_string(&config).unwrap();
+        assert_eq!(r#"{"inline_motto":"You matter even more","slice":["You","matter","even","more"],"slice_u64":[98712,12346,129389,102937]}"#, &s);
+        // the default impl is just calling underlying type defaults unless you have a custom impl Default
+        let config = Config::default();
+        let s = serde_json::to_string(&config).unwrap();
+        assert_eq!(r#"{"inline_motto":"","slice":[],"slice_u64":[]}"#, &s);
+        }
     }
 
 ```