#serde_json #json #serializer

serializers

Easily create multiple serializers for the same type

2 releases

0.1.1 Sep 28, 2018
0.1.0 Sep 28, 2018

#164 in #json

Download history 8/week @ 2018-09-29

2 downloads per month

MIT license

14KB
166 lines

Serializers

Normally when using "serde_json" and #[derive(Serialize)] you only can have one JSON representation for a type, however sometimes you might need another one which has more or less data.

This crate makes it easy to create "serializers" that take some value and turn it into JSON. You get to decide for each serializer which type it serializes, and which fields and associations it includes.

Install

[dependencies]
serializers = "0.1.2"

Example

#[macro_use]
extern crate serializers;

use serializers::*;

struct User {
    id: u64,
    name: String,
    country: Country,
    friends: Vec<User>,
}

#[derive(Clone)]
struct Country {
    id: u64,
}

serializer! {
    serialize_user<User> {
        attr(id)
        attr(name)
        has_one(country, serialize_country)
        has_many(friends, serialize_user)
    }
}

serializer! {
    serialize_country<Country> {
        attr(id)
    }
}

fn main() {
    let denmark = Country {
        id: 1,
    };

    let bob = User {
        id: 1,
        name: "Bob".to_string(),
        country: denmark.clone(),
        friends: vec![
            User {
                id: 2,
                name: "Alice".to_string(),
                country: denmark.clone(),
                friends: vec![],
            }
        ],
    };

    let json = serialize_user.serialize(&bob);

    assert_eq!(
        json,
        "{\"country\":{\"id\":1},\"friends\":[{\"country\":{\"id\":1},\"friends\":[],\"id\":2,\"name\":\"Alice\"}],\"id\":1,\"name\":\"Bob\"}"
    );
}

See the API docs for more info.

Dependencies

~1MB
~20K SLoC