3 releases

0.1.3 Sep 18, 2023
0.1.2 Sep 18, 2023
0.1.1 Sep 18, 2023

#16 in #discriminant

Download history 108/week @ 2024-07-29 221/week @ 2024-08-05 145/week @ 2024-08-12 119/week @ 2024-08-19 164/week @ 2024-08-26 31/week @ 2024-09-02 87/week @ 2024-09-09 62/week @ 2024-09-16 74/week @ 2024-09-23 180/week @ 2024-09-30 75/week @ 2024-10-07 182/week @ 2024-10-14 255/week @ 2024-10-21 67/week @ 2024-10-28 152/week @ 2024-11-04 68/week @ 2024-11-11

542 downloads per month
Used in 4 crates (via smb3)

MIT license

16KB
323 lines

serde_dis

This crate provides two macros for generating a serde Serialize and Deserialize implementation for enums.

These are SerializeWithDiscriminant and DeserializeWithDiscriminant

The implementations serializes and deserializes an enum as a struct with the discriminant as the first field and the variant fields as the following fields.

The Deserialize implementation expects the deserializer to call visit_seq for structs, this is mainly because the deserializers I was targeting do things this way. visit_map could be implemented but there is a caveat here which is that this strategy would only work if the map being deserialized always has the discriminant as the first entry.

Here are some examples

This enum will be serialized / deserialized as a u32

  #[derive(DeserializeWithDiscriminant, SerializeWithDiscriminant, Debug, PartialEq)]
  #[repr(u32)]
  enum Foo {
      A = 1,
      B = 2,
      C = 3,
  }

It also supports enums with fields

This enum will first serialize / deserialize its discriminant value (a u16) then any fields

  #[derive(DeserializeWithDiscriminant, SerializeWithDiscriminant, Debug, PartialEq)]
  #[repr(u16)]
  enum Bar {
      A(String) = 1,
      B {
          a: i32,
          b: u32,
      } = 12,
      C(i32, u64) = 7,
      #[serde(other)]
      D = 9,
  }

supported serde attributes

  • other this makes it so any unknown discriminant deserializes as this given variant
  • rename the container attribute. This lets you rename the enum.

Dependencies

~205–630KB
~15K SLoC