Popularity
4.7
Growing
Activity
1.6
-
714
26
57

Description

Header only C++ binary serialization library. It is designed around the networking requirements for real-time data delivery, especially for games.

All cross-platform requirements are enforced at compile time, so serialized data do not store any meta-data information and is as small as possible.

Programming language: C++
License: MIT License
Tags: Serialization     Cpp11     Cpp14    
Latest version: v5.2.2

Bitsery alternatives and similar libraries

Based on the "Serialization" category.
Alternatively, view Bitsery alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of Bitsery or a related project?

Add another 'Serialization' Library

README

Bitsery

Build On Windows Build On Mac Build On Linux Join the chat at https://gitter.im/bitsery/Lobby

Header only C++ binary serialization library. It is designed around the networking requirements for real-time data delivery, especially for games.

All cross-platform requirements are enforced at compile time, so serialized data do not store any meta-data information and is as small as possible.

bitsery is looking for your feedback on gitter

Features

  • Cross-platform compatible.
  • Optimized for speed and space.
  • No code generation required: no IDL or metadata, just use your types directly.
  • Configurable runtime error checking on deserialization.
  • Can read/write from any source: stream (file, network stream. etc... ), or buffer (vector, c-array, etc...).
  • Don't pay for what you don't use! - customize your serialization via extensions. Some notable extensions allow:
    • fine-grained bit-level serialization control.
    • forward/backward compatibility for your types.
    • smart and raw pointers with allocators support and customizable runtime polymorphism.
  • Easily extendable for any type.
  • Allows brief (similar to cereal) or/and verbose syntax for better serialization control.
  • Configurable endianness support.
  • No macros.

Why use bitsery

Look at the numbers and features list, and decide yourself.

library data size ser time des time
bitsery 6913B 1119ms 1166ms
boost 11037B 15391ms 12912ms
cereal 10413B 10518ms 10245ms
flatbuffers 14924B 9075ms 3701ms
msgpack 8857B 3340ms 13842ms
protobuf 10018B 21229ms 22077ms
yas 10463B 2107ms 1554ms

benchmarked on Ubuntu with GCC 10.3.0, more details can be found here

If still not convinced read more in library [motivation](doc/design/README.md) section.

Usage example

#include <bitsery/bitsery.h>
#include <bitsery/adapter/buffer.h>
#include <bitsery/traits/vector.h>

enum class MyEnum:uint16_t { V1,V2,V3 };
struct MyStruct {
    uint32_t i;
    MyEnum e;
    std::vector<float> fs;
};

template <typename S>
void serialize(S& s, MyStruct& o) {
    s.value4b(o.i);
    s.value2b(o.e);
    s.container4b(o.fs, 10);
}

using Buffer = std::vector<uint8_t>;
using OutputAdapter = bitsery::OutputBufferAdapter<Buffer>;
using InputAdapter = bitsery::InputBufferAdapter<Buffer>;

int main() {
    MyStruct data{8941, MyEnum::V2, {15.0f, -8.5f, 0.045f}};
    MyStruct res{};

    Buffer buffer;

    auto writtenSize = bitsery::quickSerialization<OutputAdapter>(buffer, data);
    auto state = bitsery::quickDeserialization<InputAdapter>({buffer.begin(), writtenSize}, res);

    assert(state.first == bitsery::ReaderError::NoError && state.second);
    assert(data.fs == res.fs && data.i == res.i && data.e == res.e);
}

For more details go directly to [quick start](doc/tutorial/hello_world.md) tutorial.

How to use it

This documentation comprises these parts:

  • [Tutorial](doc/tutorial/README.md) - getting started.
  • [Reference section](doc/README.md) - all the details.

documentation is in progress, most parts are empty, but [contributions](CONTRIBUTING.md) are welcome.

Requirements

Works with C++11 compiler, no additional dependencies, include <bitsery/bitsery.h> and you're done.

some bitsery extensions might require higher C++ standard (e.g. StdVariant)

Platforms

Library is tested on all major compilers on Windows, Linux and macOS.

There is a patch that allows using bitsery with non-fully compatible C++11 compilers.

  • CentOS 7 with gcc 4.8.2.

License

bitsery is licensed under the [MIT license](LICENSE).


*Note that all licence references and agreements mentioned in the Bitsery README section above are relevant to that project's source code only.