#compact #serialization #serde #name #field-name

macro serde_compact

Macros to compact structs and enums serialized with serde

3 releases

1.0.0-rc.3 Aug 3, 2022

#1520 in Encoding

Download history 2/week @ 2024-02-19 21/week @ 2024-02-26 27/week @ 2024-03-11 31/week @ 2024-04-01

58 downloads per month

MIT/Apache

10KB
103 lines

License: MIT License: Apache

Serde Compact

Macros to compact structs and enums serialized with serde.

Field names and enum tags are shortened and mapped with #[serde(rename ="")] macro trading-off serialized data external interoperability for up to 50% size reduction. Use when both serialization and deserialization happens in Rust.

use serde_compact::compact;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug)]
enum CallbackQuery {
    ReservationConfirmation { event_id: i32, user_id: i32, ticket_type: i32 },
    // ...
}

#[compact] // <= add before deriving Serialize
#[derive(Serialize, Deserialize, PartialEq, Debug)]
enum CompactCallbackQuery {
    ReservationConfirmation { event_id: i32, user_id: i32, ticket_type: i32 },
    // ...
}

fn main() {
    // Original serialization
    let s = CallbackQuery::ReservationConfirmation {event_id: 1, user_id: 1, ticket_type: 1};
    let ser_s = serde_json::to_string(&s).unwrap();
    assert_eq!(ser_s, r#"{"ReservationConfirmation":{"event_id":1,"user_id":1,"ticket_type":1}}"#);
    assert_eq!(ser_s.len(), 70);

    // Compacted
    let cs = CompactCallbackQuery::ReservationConfirmation {event_id: 1, user_id: 1, ticket_type: 1};
    let ser_cs = serde_json::to_string(&cs).unwrap();
    assert_eq!(ser_cs, r#"{"a":{"b":1,"d":1,"c":1}}"#);
    assert_eq!(ser_cs.len(), 25);

    let de: CompactCallbackQuery = serde_json::from_str(&ser_cs).unwrap();
    assert_eq!(cs, de);
}

Dependencies

~1.5MB
~34K SLoC