Home|About|Gaming cabinet|Archives|How it works|Starter sites

GeezerVison is showing rfl.getml.com — reflect-cpp

Documentation

The basics

How to install reflect-cpp using vcpkg, conan, cmake or direct inclusion.

Supported formats

What formats are supported by reflect-cpp, such as JSON, XML, msgpack, etc.

Recaps the motivating example in the README.

Optional fields

For defining fields that might be absent in your serialized format.

Struct flattening

For making struct A inherit the fields of struct B.

For modifying structs before serialization and deserialization.

The rfl::Field-syntax

An alternative syntax that allows for powerful functionalities.

String literals

For representing strings that can only assume a limited number of enumerated values.

How reflect-cpp handles C++ enums.

std::variant and rfl::TaggedUnion

For structs that can be one of several formats.

rfl::Box and rfl::Ref

For defining recursive structures.

rfl::Timestamp and std::chrono::duration

For serializing and deserializing timestamps and durations.

For skipping fields during serialization and/or deserialization.

For adding comments to your serialized format.

For error handling without exceptions.

Standard containers

How reflect-cpp treats containers in the standard library.

For serializing and deserializing std::expected, the C++-23 result type.

C arrays and inheritance

How reflect-cpp handles C arrays and inheritance.

rfl::Bytestring

How reflect-cpp handles binary strings for formats that support them.

rfl::Binary, rfl::Hex and rfl::Oct

For expressing numbers in different formats.

For defining default values for fields that might be absent.

For serializing and deserializing atomic types.

Validation

For requiring that strings follow user-defined regex patterns.

Validating numbers

For imposing constraints on numbers.

Composing validators

For defining more complex validators using operators.

Size validation

For imposing size constraints on containers.

For validating your schema before you send it to your C++ backend.

Generic elements

A map-like type representing an object with unknown field names.

A catch-all type that can represent almost anything.

rfl::ExtraFields

For adding extra fields with unknown names.

Custom classes

For custom classes with private fields.

Custom parsers for your classes

For custom classes that you want to leave untouched.

Useful helper functions and classes

For replacing one or several fields in a struct.

For casting structs as other structs.

rfl::NamedTuple

For structural typing.

An alternative to std::tuple that compiles more quickly.

For accessing fields of a struct by index or name.

Advanced topics

Supporting your own format

For supporting your own serialization and deserialization formats.

Maintaining backwards compatibility

Instructions for ensuring backwards-compatible APIs.

Extensive benchmarks of popular serialization libraries.

Contributing

How to contribute

How to contribute to reflect-cpp.

Build the documentation

How to build the documentation locally.