Module serde_yml::with::singleton_map

Serialize/deserialize an enum using a YAML map containing one entry in which the key identifies the variant name.

Example

use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, PartialEq, Debug)]
enum Enum {
    Unit,
    Newtype(usize),
    Tuple(usize, usize),
    Struct { value: usize },
}

#[derive(Serialize, Deserialize, PartialEq, Debug)]
struct Struct {
    #[serde(with = "serde_yml::with::singleton_map")]
    w: Enum,
    #[serde(with = "serde_yml::with::singleton_map")]
    x: Enum,
    #[serde(with = "serde_yml::with::singleton_map")]
    y: Enum,
    #[serde(with = "serde_yml::with::singleton_map")]
    z: Enum,
}

    let object = Struct {
        w: Enum::Unit,
        x: Enum::Newtype(1),
        y: Enum::Tuple(1, 1),
        z: Enum::Struct { value: 1 },
    };

    let yaml = serde_yml::to_string(&object).unwrap();
    print!("{}", yaml);

    let deserialized: Struct = serde_yml::from_str(&yaml).unwrap();
    assert_eq!(object, deserialized);

The representation using singleton_map on all the fields is:

w: Unit
x:
  Newtype: 1
y:
  Tuple:
  - 1
  - 1
z:
  Struct:
    value: 1

Without singleton_map, the default behaviour would have been to serialize as:

w: Unit
x: !Newtype 1
y: !Tuple
- 1
- 1
z: !Struct
  value: 1

Structs

• SerializeStructVariantAsSingletonMap
  A helper struct for serializing struct variants as singleton maps.
• SerializeTupleVariantAsSingletonMap
  A helper struct for serializing tuple variants as singleton maps.
• SingletonMap
  A wrapper struct that delegates serialization and deserialization to an underlying serializer or deserializer.

Functions

• deserialize
• serialize
  Serializes a given value using a singleton map representation.