build: update version to 1.0.0

(Closes #12)

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "serde-inline-default"
-version = "0.2.2"
+version = "1.0.0"
 authors = ["bytedream"]
 edition = "2021"
 description = "Serde default values via inline declaration"

README.md

@@ -1,12 +1,12 @@
-# serde-inline-default [![ci](https://github.com/ByteDream/serde-inline-default/actions/workflows/ci.yml/badge.svg)](https://github.com/ByteDream/serde-inline-default/actions/workflows/ci.yml) [![crates.io](https://img.shields.io/crates/v/serde-inline-default)](https://crates.io/crates/serde-inline-default) [![docs](https://img.shields.io/docsrs/serde-inline-default)](https://docs.rs/serde-inline-default/latest/serde_inline_default/)
+# serde-inline-default [![ci](https://github.com/ByteDream/serde-inline-default/actions/workflows/ci.yml/badge.svg)](https://github.com/ByteDream/serde-inline-default/actions/workflows/ci.yml) [![crates.io](https://img.shields.io/crates/v/serde-inline-default)](https://crates.io/crates/serde-inline-default) [![crates.io downloads](https://img.shields.io/crates/d/serde-inline-default)](https://crates.io/crates/serde-inline-default) [![docs](https://img.shields.io/docsrs/serde-inline-default)](https://docs.rs/serde-inline-default/latest/serde_inline_default/)
 
-Tiny crate to set default values for serde fields via inline attribute declaration.
+A tiny crate to set default values for serde struct fields via inline attribute declaration.
 
 ## Overview
 
-This crate is an approach to do what [serde-rs/serde#368](https://github.com/serde-rs/serde/issues/368) purposes.
+This crate is an approach to do what [serde-rs/serde#368](https://github.com/serde-rs/serde/issues/368) purposes: Defining default values for struct fields via inline declaration instead of creating a separate function for it.
-If you want to set default values in plain [`serde`](https://serde.rs/), you have to create a function and link to it with `#[serde(default = "...")`.
+
-This may be good if you need to do calculations to get the default value, but often you just want a simple integer or string to be the default value and have to create a whole function to return a hard-coded value.
+So instead of writing something like this, which can get very verbose quickly with many fields:
 ```rust
 #[derive(Deserialize)]
 struct Test {
@@ -16,11 +16,7 @@ struct Test {
 
 fn value_default() -> u32 { 42 }
 ```
-
+you can just do this:
-That can get quiet messy if you have many fields with many (different) default values.
-This crate tries to solve this issue by providing the `#[serde_inline_default]` proc macro.
-With this macro set at the struct level (_**before `#[derive(Deserialize)]`/`#[derive(Serialize)]`!, otherwise it's not working correctly**_), you can set default values via `#[serde_inline_default(...)]` for your serde fields inline, without creating an extra function.
-
 ```rust
 #[serde_inline_default]
 #[derive(Deserialize)]
@@ -30,8 +26,53 @@ struct Test {
 }
 ```
 
+> [!IMPORTANT]
+> **`#[serde_inline_default]` must be set before `#[derive(Deserialize)]`/`#[derive(Serialize)]`!**
+
 Internally, `#[serde_inline_default(...)]` gets expanded to a function which returns the set value and the attribute is replaced with `#[serde(default = "<function name>")]`.
-So this macro is just some syntax sugar for you, but can get quiet handy if you want to keep your code clean or write declarative macros / `macro_rules!`.
+So this macro is just some syntax sugar for you, but can get quite handy if you want to keep your code clean or write declarative macros / `macro_rules!`.
+
+## Alternatives
+
+This crate isn't perfect. Thus, you might be more satisfied with alternatives `serde` provides.
+
+With `#[serde(default)]` + `impl Default` on a struct, `serde` uses the default implementation of the struct to get default values for each field ([docs](https://serde.rs/container-attrs.html#default)):
+```rust
+#[derive(Deserialize)]
+#[serde(default)]
+struct Test {
+    value: u32
+}
+
+impl Default for Test {
+    fn default() -> Self {
+        Self {
+            value: 42
+        }
+    }
+}
+```
+
+If you still need/want `serde-inline-default` features, you also can combine them with `#[serde(default))` and `impl Default`:
+```rust
+#[serde_inline_default]
+#[derive(Deserialize)]
+#[serde(default)]
+struct Test {
+    value: u32,
+    #[serde_inline_default(0)]
+    other_value: u32,
+}
+
+impl Default for Test {
+    fn default() -> Self {
+        Self {
+            value: 42,
+            other_value: 42
+        }
+    }
+}
+```
 
 ## License
 

src/expand.rs

@@ -4,7 +4,7 @@ use quote::quote;
 use syn::{parse_quote, ItemStruct};
 
 pub(crate) fn expand_struct(mut item: ItemStruct) -> proc_macro::TokenStream {
-    let mut inline_fns: Vec<(String, TokenStream, TokenStream)> = vec![];
+    let mut inline_fns: Vec<TokenStream> = vec![];
 
     for (i, field) in item.fields.iter_mut().enumerate() {
         for (j, attr) in field.attrs.iter_mut().enumerate() {
@@ -14,31 +14,30 @@ pub(crate) fn expand_struct(mut item: ItemStruct) -> proc_macro::TokenStream {
 
             let default: TokenStream = attr.parse_args().unwrap();
 
-            // we check here if a function with the exact same return value already exists. if so,
+            // copy all the same #[cfg] conditional compilations flags for the field onto our built
-            // this function gets used.
+            // default function.
-            let fn_name_lit = if let Some((fn_name_lit, _, _)) = inline_fns
+            // otherwise, it's possible to create a constructor for a type that may be filtered by
-                .iter()
+            // the same #[cfg]'s, breaking compilation
-                .find(|(_, def, _)| def.to_string() == default.to_string())
+            let cfg_attrs = field.attrs.iter().filter(|a| a.path().is_ident("cfg"));
-            {
+
-                fn_name_lit.clone()
-            } else {
             let fn_name_lit = format!("__serde_inline_default_{}_{}", item.ident, i);
             let fn_name_ident = Ident::new(&fn_name_lit, Span::call_site());
             let mut return_type = field.ty.clone();
 
-                // replaces most lifetimes with 'static
+            // replace lifetimes with 'static.
+            // the built default function / default values in general can only be static as they're
+            // generated without reference to the parent struct
             type_lifetimes_to_static(&mut return_type);
 
-                let inline_fn = quote! {
+            inline_fns.push(quote! {
                 #[doc(hidden)]
                 #[allow(non_snake_case)]
+                #( #cfg_attrs )*
                 fn #fn_name_ident () -> #return_type {
                     #default
                 }
-                };
+            });
-                inline_fns.push((fn_name_lit.clone(), default, inline_fn));
+
-                fn_name_lit
-            };
             field.attrs.remove(j);
             field
                 .attrs
@@ -47,10 +46,8 @@ pub(crate) fn expand_struct(mut item: ItemStruct) -> proc_macro::TokenStream {
         }
     }
 
-    let real_inline_fns: Vec<TokenStream> =
-        inline_fns.into_iter().map(|(_, _, func)| func).collect();
     let expanded = quote! {
-        #( #real_inline_fns )*
+        #( #inline_fns )*
 
         #item
     };

src/lib.rs

@@ -8,12 +8,15 @@ mod utils;
 
 /// The main macro of this crate.
 /// Use it to define default values of fields in structs you [`Serialize`] or [`Deserialize`].
-/// You do not need to create a extra function to provide the default value, as it is the case in serdes' implementation of default (`#[serde(default = "...")]`).
+/// You do not need to create an extra function to provide the default value, as it is the case in
+/// serdes' implementation of default (`#[serde(default = "...")]`).
 ///
-/// Set this macro on a struct where you use [`Serialize`] or [`Deserialize`] and use `#[serde_inline_default(...)]` on the field you want to have a inline default value.
+/// Set this macro on a struct where you use [`Serialize`] or [`Deserialize`] and use
-/// Replace the `...` with the value you want and it will be set as default if serde needs it.
+/// `#[serde_inline_default(...)]` on the field you want to have an inline default value.
+/// Replace the `...` with the value you want, and it will be set as default if serde needs it.
 ///
-/// Note that you must set this macro _before_ `#[derive(Serialize)]` / `#[derive(Deserialize)]` as it wouldn't work properly if set after the derive.
+/// Note that you must set this macro _before_ `#[derive(Serialize)]` / `#[derive(Deserialize)]` as
+/// it won't work properly if it's set after the derive.
 ///
 /// # Examples
 ///

tests/test_serde_inline_default.rs

@@ -43,3 +43,26 @@ fn test_lifetime() {
 
     assert_eq!(lifetime_test.test_str, "test");
 }
+
+#[test]
+#[allow(dead_code)]
+fn test_conditional_compilation() {
+    #[cfg(debug_assertions)]
+    #[derive(Deserialize)]
+    struct TypeA(u8);
+
+    #[cfg(not(debug_assertions))]
+    #[derive(Deserialize)]
+    struct TypeB(u8);
+
+    #[serde_inline_default]
+    #[derive(Deserialize)]
+    struct Test {
+        #[cfg(debug_assertions)]
+        #[serde_inline_default(TypeA(1))]
+        val_a: TypeA,
+        #[cfg(not(debug_assertions))]
+        #[serde_inline_default(TypeB(1))]
+        val_b: TypeB,
+    }
+}