Module kserd::encode

Encoder and Decoder for converting between data structures and Kserd.

Requires the encode feature.

Kserd leverages serde to encode a data object into a Kserd data format and back again. Any type that implements Serialize can be encoded to a Kserd, and any type that implements Deserialize can be decoded back to that type from a Kserd object.

It is important to understand lifetime subtleties between encoding and decoding, the api documentation on Encoder and Decoder have explanations. There is an alternate encoding method which uses the trait ToKserd that can consume the implementor object.

Examples

Encoding can be done for any type that implements Serialize.

let data = (
    100,
    "Hello, world!",
    3.14
);

let expected = Kserd::new(Value::Tuple(
    vec![
        Kserd::new_num(100),
        Kserd::new_str("Hello, world!"),
        Kserd::new_num(3.14)
    ]
));

let kserd = Kserd::enc(&data);
assert_eq!(kserd, Ok(expected));

Decoding can be done for any type that implements Deserialize.

let kserd = Kserd::new(Value::Tuple(
    vec![
        Kserd::new_num(100),
        Kserd::new_str("Hello, world!"),
        Kserd::new_num(3.14)
    ]
));

let expected = (
    100,
    "Hello, world!",
    3.14
);

let r = kserd.decode::<(u32, &str, f32)>();
assert_eq!(r, Ok(expected));

An example of a round trip.

let data = (
    100,
    "Hello, world!".to_string(), // see Decoder docs for lifetime subtleties
    3.14
);

let kserd = Kserd::enc(&data).unwrap();
let r = kserd.decode::<(u32, String, f32)>();
assert_eq!(r, Ok(data));

Structs

Decoder	Decoder to pass to Deserialize::deserialize to decode a Kserd into a type.
Encoder	Encoder to pass to Serialize::serialize to encode a type into a Kserd.

Traits

Deserialize	A data structure that can be deserialized from any data format supported by Serde.
Serialize	A data structure that can be serialized into any data format supported by Serde.