Skip to content

Reflection brings the best way to serialize/deserialize json and yaml in C++

License

Notifications You must be signed in to change notification settings

chocolacula/easy_reflection_cpp

Repository files navigation

Easy Reflection solution for C++

CMake build and test Listed on Awesome C++

It parses C++ source code for special attributes. In the most straightforward situation, you only need to mark an object by [[er::reflect]] attribute. All other work will be done by the code generation tool and reflection library.

The main idea is to use kinda dynamic typing for some type agnostic operations, like copying or getting the name of a type.
It makes it possible to determine a variable type and do the right job - print, serialize/deserialize.

If you are curious about the details of how it works you can find them in DEV article.

Features

  • Linux, MacOS and Windows, x86 and ARM support
  • translate enums to string and vice versa
  • invoke methods
  • support of stl containers like std::vector, std::list, std::map, etc.
  • smart pointers support
  • native serialization directly to an object and without third parties for:
    • JSON
    • YAML 1.2 even with anchors, but keep in mind that variables behind anchors have to be the same type.
    • binary with Variable Length Quantity to reduce number of bytes
  • debug printing
  • understandable errors

Quick start

Look at Installation guide and install the solution.

Then define your object and use [[er::reflect]]:

class [[er::reflect]] Object {
 public:
  std::string field_str;
  int field_int;

  std::vector<int> field_vector;
}

And serialize/deserialize it in one shot:

#include "generated/reflection.h"
#include "er/serialization/json.h"

using namespace serialization;

...
auto str = json::to_string<Object>(obj).unwrap();
obj = json::from_string<Object>(str).unwrap();
...

For more details see How To Use.

Performance

The repository includes benchmarks folder, feel free to check it on your own hardware.

JSON is faster than nlohmann json. Serialization is the same fast as rapid json, deserialization is a little faster with simdjson parser and more than twice slower without.

YAML is blazingly faster than yaml-cpp if I did the benchmark right.

Note: Other libraries do not always convert string-represented values to int, float, or bool and don't create instances of std::string until you call something like .get<int>(). Easy Reflection, on the other hand, provides ready-made objects with all values within.

Core i5 benchmarks

Memory

The ratio of the content length in bytes

Thanks

JetBrains for Open Source Support

              JetBrains Logo