Add a `skip_serializing_null` attribute #46

jonasbb · 2019-03-19T19:24:35Z

The skip_serializing_null attribute can be added to any struct and adds #[serde(skip_serializing_if = "Option::is_none")] to every Option field.
The intended use is for parsing data, e.g., from APIs, which has many optional values.

It turns

#[skip_serializing_null]
#[derive(Serialize)]
struct Data {
    a: Option<String>,
    b: Option<String>,
    c: Option<String>,
    d: Option<String>,
}

into

#[derive(Serialize)]
struct Data {
    #[serde(skip_serializing_if = "Option::is_none")]
    a: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    b: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    c: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    d: Option<String>,
}

The issue was originally suggested at dtolnay/request-for-implementation#18.

Missing

Is skip_serializing_null the best name? That is how serde or JSON name the empty value, in Rust it is none.
Support tuple structs
Support enums
Handle existing skip_serializing_if annotations, by skipping those fields
Support an additional attribute, which ensures the field is always serialized
Write compile tests, which ensure the correct error message
Write documentation for the feature

codecov · 2019-03-21T21:18:56Z

Codecov Report

Merging #46 into master will decrease coverage by 3.59%.
The diff coverage is 41.37%.

@@            Coverage Diff            @@
##           master      #46     +/-   ##
=========================================
- Coverage   75.44%   71.84%   -3.6%     
=========================================
  Files          11       14      +3     
  Lines         737      824     +87     
=========================================
+ Hits          556      592     +36     
- Misses        181      232     +51

Impacted Files	Coverage Δ
src/lib.rs	`25% <ø> (ø)`	⬆️
serde_with_macros/src/lib.rs	`0% <0%> (ø)`
serde_with_macros/tests/skip_serializing_null.rs	`100% <100%> (ø)`
serde_with_macros/tests/version_numbers.rs	`100% <100%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a05488a...e078ca8. Read the comment docs.

codecov · 2019-03-21T21:18:57Z

Codecov Report

Merging #46 into master will decrease coverage by 2.5%.
The diff coverage is 51.72%.

@@            Coverage Diff             @@
##           master      #46      +/-   ##
==========================================
- Coverage   75.44%   72.93%   -2.51%     
==========================================
  Files          11       14       +3     
  Lines         737      824      +87     
==========================================
+ Hits          556      601      +45     
- Misses        181      223      +42

Impacted Files	Coverage Δ
src/lib.rs	`25% <ø> (ø)`	⬆️
serde_with_macros/src/lib.rs	`0% <0%> (ø)`
serde_with_macros/tests/skip_serializing_null.rs	`100% <100%> (ø)`
serde_with_macros/tests/version_numbers.rs	`100% <100%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 26d84b1...cf89b47. Read the comment docs.

A proc_macro is required to implement skip_serializing_null from dtolnay/request-for-implementation#18 Expose the macro crate in serde_with * Add a "macros"-feature to disable compiling proc_macros * Add the feature to the testing matrix

jonasbb · 2019-03-31T21:39:37Z

bors r+

46: Add a `skip_serializing_null` attribute r=jonasbb a=jonasbb The `skip_serializing_null` attribute can be added to any struct and adds `#[serde(skip_serializing_if = "Option::is_none")]` to every `Option` field. The intended use is for parsing data, e.g., from APIs, which has many optional values. It turns ```rust #[skip_serializing_null] #[derive(Serialize)] struct Data { a: Option<String>, b: Option<String>, c: Option<String>, d: Option<String>, } ``` into ```rust #[derive(Serialize)] struct Data { #[serde(skip_serializing_if = "Option::is_none")] a: Option<String>, #[serde(skip_serializing_if = "Option::is_none")] b: Option<String>, #[serde(skip_serializing_if = "Option::is_none")] c: Option<String>, #[serde(skip_serializing_if = "Option::is_none")] d: Option<String>, } ``` The issue was originally suggested at dtolnay/request-for-implementation#18. # Missing * [x] Is `skip_serializing_null` the best name? That is how serde or JSON name the empty value, in Rust it is none. * [x] Support tuple structs * [x] Support enums * [x] Handle existing `skip_serializing_if` annotations, by skipping those fields * [x] Support an additional attribute, which ensures the field is always serialized * [x] Write compile tests, which ensure the correct error message * [x] Write documentation for the feature Co-authored-by: Jonas Bushart <[email protected]>

bors · 2019-03-31T21:55:05Z

Build failed

continuous-integration/travis-ci/push

jonasbb · 2019-04-02T18:58:44Z

bors try

bors · 2019-04-02T19:06:59Z

try

Build succeeded

continuous-integration/travis-ci/push

jonasbb · 2019-04-02T19:16:47Z

bors r+

46: Add a `skip_serializing_null` attribute r=jonasbb a=jonasbb The `skip_serializing_null` attribute can be added to any struct and adds `#[serde(skip_serializing_if = "Option::is_none")]` to every `Option` field. The intended use is for parsing data, e.g., from APIs, which has many optional values. It turns ```rust #[skip_serializing_null] #[derive(Serialize)] struct Data { a: Option<String>, b: Option<String>, c: Option<String>, d: Option<String>, } ``` into ```rust #[derive(Serialize)] struct Data { #[serde(skip_serializing_if = "Option::is_none")] a: Option<String>, #[serde(skip_serializing_if = "Option::is_none")] b: Option<String>, #[serde(skip_serializing_if = "Option::is_none")] c: Option<String>, #[serde(skip_serializing_if = "Option::is_none")] d: Option<String>, } ``` The issue was originally suggested at dtolnay/request-for-implementation#18. # Missing * [x] Is `skip_serializing_null` the best name? That is how serde or JSON name the empty value, in Rust it is none. * [x] Support tuple structs * [x] Support enums * [x] Handle existing `skip_serializing_if` annotations, by skipping those fields * [x] Support an additional attribute, which ensures the field is always serialized * [x] Write compile tests, which ensure the correct error message * [x] Write documentation for the feature Co-authored-by: Jonas Bushart <[email protected]>

bors · 2019-04-02T19:25:44Z

Build succeeded

continuous-integration/travis-ci/push

doivosevic · 2022-01-12T09:08:17Z

I cannot find this macro. How do we include it? Googling for it gives no results

jonasbb · 2022-01-12T11:54:19Z

@doivosevic You find all the information in the documentation https://docs.rs/serde_with. Please open a new discussion if you need support and do not comment on year old PRs.

jonasbb changed the title ~~Add a skip_serializing_null attribute~~ [WIP] Add a skip_serializing_null attribute Mar 19, 2019

jonasbb mentioned this pull request Mar 19, 2019

Attribute macro to skip serializing all fields of Option type dtolnay/request-for-implementation#18

Closed

Repository owner deleted a comment from codecov bot Mar 19, 2019

Repository owner deleted a comment from codecov bot Mar 21, 2019

jonasbb changed the title ~~[WIP] Add a skip_serializing_null attribute~~ Add a skip_serializing_null attribute Mar 31, 2019

jonasbb added 6 commits March 31, 2019 23:22

Add a proc_macro component to serde_with

fb20c9f

A proc_macro is required to implement skip_serializing_null from dtolnay/request-for-implementation#18 Expose the macro crate in serde_with * Add a "macros"-feature to disable compiling proc_macros * Add the feature to the testing matrix

Add first version supporting named structs

62866b8

Add html_root_url test

71bfd03

Add support for enums in addition to tuples

e0d07d8

Do not add attribute, if there is an existing skip-serialization_if

ffcaf00

Also parse serialize_always

f7f64e3

jonasbb force-pushed the proc_macros branch from ea436ed to c46179c Compare March 31, 2019 21:25

jonasbb added 2 commits April 2, 2019 20:42

Rename macro to skip_serializing_none

5ae2c21

Add documentation for skip_serializing_none

f9d5fa0

jonasbb force-pushed the proc_macros branch from c46179c to f9d5fa0 Compare April 2, 2019 18:56

bors bot added a commit that referenced this pull request Apr 2, 2019

Try #46:

1507de3

Extend documentation a bit

cf89b47

bors bot merged commit cf89b47 into master Apr 2, 2019

bors bot deleted the proc_macros branch April 2, 2019 19:25

Repository owner locked as off-topic and limited conversation to collaborators Jan 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a `skip_serializing_null` attribute #46

Add a `skip_serializing_null` attribute #46

jonasbb commented Mar 19, 2019 •

edited

Loading

codecov bot commented Mar 21, 2019

codecov bot commented Mar 21, 2019 •

edited

Loading

jonasbb commented Mar 31, 2019

bors bot commented Mar 31, 2019

jonasbb commented Apr 2, 2019

bors bot commented Apr 2, 2019

jonasbb commented Apr 2, 2019

bors bot commented Apr 2, 2019

doivosevic commented Jan 12, 2022

jonasbb commented Jan 12, 2022

Add a skip_serializing_null attribute #46

Add a skip_serializing_null attribute #46

Conversation

jonasbb commented Mar 19, 2019 • edited Loading

Missing

codecov bot commented Mar 21, 2019

Codecov Report

codecov bot commented Mar 21, 2019 • edited Loading

Codecov Report

jonasbb commented Mar 31, 2019

bors bot commented Mar 31, 2019

Build failed

jonasbb commented Apr 2, 2019

bors bot commented Apr 2, 2019

try

Build succeeded

jonasbb commented Apr 2, 2019

bors bot commented Apr 2, 2019

Build succeeded

doivosevic commented Jan 12, 2022

jonasbb commented Jan 12, 2022

Add a `skip_serializing_null` attribute #46

Add a `skip_serializing_null` attribute #46

jonasbb commented Mar 19, 2019 •

edited

Loading

codecov bot commented Mar 21, 2019 •

edited

Loading