Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BlackEdder/painlessjson
D library for converting any custom types to and from JSON the painless way.
https://github.com/BlackEdder/painlessjson
Last synced: about 2 hours ago
JSON representation
D library for converting any custom types to and from JSON the painless way.
- Host: GitHub
- URL: https://github.com/BlackEdder/painlessjson
- Owner: BlackEdder
- License: bsl-1.0
- Created: 2014-07-25T08:43:08.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-07-12T07:01:44.000Z (over 5 years ago)
- Last Synced: 2024-10-14T21:15:24.600Z (about 1 month ago)
- Language: D
- Size: 118 KB
- Stars: 23
- Watchers: 4
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-d - painlessjson - Convert between D types and std.json. (Data serialization / JSON)
README
# Painless JSON [](https://travis-ci.org/BlackEdder/painlessjson)
Library to painlessly convert your custom types (structs and classes) to and from JSON. This library provides the function toJSON and fromJSON to automatically convert any type to and from JSON. It is possible to override the implementation by defining your own `_toJSON` and `_fromJSON` member functions for a type or with User Defined Attributes. The default conversion works by converting all member variables of a type to and from JSON (including functions with the `@property` attribute). Constructors will be used automatically if no default-constructor is available.
Painlessjson works by serializing a class/struct using compile time reflection and converts the public fields to a JSON object. You can influence the serialisation/seserialization with the following User Defined Attributes:
- `@SerializeToIgnore` & `@SerializeFromIgnore` disable serialization in the to step or the from step
- `@SerializeIgnore` is the same as combining `@SerializeToIgnore` and `@SerializeToIgnore`, and disables serialization/deserialization for the variable
- `@SerializedName('Name')` Use specified name when serializing/deserializing
- `@SerializedName('To', 'From')` Use a different name when serializing/deserializing
- `@SerializedToName('To')` & `@SerializedFromName('From')` Alternative way of defining names.
## Installation
Installation is mostly managed through , so you can add it to your dependencies in your dub.json file.
You can also generate the library by hand with:
```sh
git clone http://github.com/BlackEdder/painlessjson.git
cd painlessjson
dub build -b release
```
## Examples
```D
import std.json;
import painlessjson;
struct Point
{
double x = 0;
double y = 1;
}
Point point;
auto json = point.toJSON; // => q{{"x":0,"y":1}}
auto newPoint = fromJSON!Point(parseJSON(q{{"x":-1,"y":2}}));
class IdAndName
{
immutable string name;
immutable int id;
this(int id, string name)
{
this.id = id;
this.name = name;
}
this(int id)
{
this.id = id;
this.name = "Undefined";
}
}
auto person = fromJSON!IdAndName(parseJSON(q{{"id":34, "name": "Jason Pain"}}));
assertEqual(person.id, 34);
assertEqual(person.name, "Jason Pain");
```
More detailed examples can be found in the [master branch documentation on Github][master docs github], the [master branch documentation on ddocs.org][master docs ddocs], or the [latest release documentation on ddocs.org][release docs]. The classes/structs used in the examples are defined [here][unittest types].
## Performance
The library uses compile time reflection to find the fields in your classes. This generates the same code as a handwritten implementation would. It uses std.json on the backend and performance is mainly determined by the std.json implementation. At the moment of writing (2014) std.json is known to be slow compared to other languages. Hopefully, this will be improved over time.
## Tested compilers
[master docs github]: http://blackedder.github.io/painlessjson/painlessjson.html
[master docs ddocs]: http://ddocs.org/painlessjson/~master/painlessjson/painlessjson.html
[release docs]: http://ddocs.org/painlessjson/~master/painlessjson/painlessjson.html
[unittest types]: https://github.com/BlackEdder/painlessjson/blob/master/source/painlessjson/unittesttypes.d