serializers

Crates.ioserializers
lib.rsserializers
version0.2.3
sourcesrc
created_at2018-09-28 22:39:29.517494
updated_at2018-11-17 18:49:28.637639
descriptionEasily create multiple serializers for the same type
homepagehttps://github.com/davidpdrsn/serializers
repositoryhttps://github.com/davidpdrsn/serializers.git
max_upload_size
id87049
size23,883
David Pedersen (davidpdrsn)

documentation

https://docs.rs/serializers/

README

Serializers

Build Status Crates.io Documentation

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.2.3"

Example

#[macro_use]
extern crate serializers;
#[macro_use]
extern crate serde_json;

use serializers::*;

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

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

serializer! {
    #[derive(Debug, Copy, Clone)]
    struct UserSerializer<User> {
        attr(id)
        attr(name)
        has_one(country, CountrySerializer)
        has_many(friends, UserSerializer)
    }
}

serializer! {
    #[derive(Debug, Copy, Clone)]
    struct CountrySerializer<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: String = UserSerializer::serialize(&bob);

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

See the API docs for more info.

Commit count: 29

cargo fmt