Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/fraillt/bitsery

Your binary serialization library
https://github.com/fraillt/bitsery

binary-serialization cpp11 cpp14 serialization

Last synced: about 2 months ago
JSON representation

Your binary serialization library

Lists

README 

        
# Bitsery



[![Build On Windows](https://github.com/fraillt/bitsery/actions/workflows/on_windows.yml/badge.svg)](https://github.com/fraillt/bitsery/actions/workflows/on_windows.yml)

[![Build On Mac](https://github.com/fraillt/bitsery/actions/workflows/on_mac.yml/badge.svg)](https://github.com/fraillt/bitsery/actions/workflows/on_mac.yml)

[![Build On Linux](https://github.com/fraillt/bitsery/actions/workflows/on_linux.yml/badge.svg)](https://github.com/fraillt/bitsery/actions/workflows/on_linux.yml)

[![Join the chat at https://gitter.im/bitsery/Lobby](https://badges.gitter.im/bitsery/Lobby.svg)](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](https://gitter.im/bitsery/Lobby)



## 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](https://uscilab.github.io/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](https://github.com/fraillt/cpp_serializers_benchmark.git)*



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



## Usage example

```cpp

#include 

#include 

#include 



enum class MyEnum:uint16_t { V1,V2,V3 };

struct MyStruct {

    uint32_t i;

    MyEnum e;

    std::vector fs;

};



template 

void serialize(S& s, MyStruct& o) {

    s.value4b(o.i);

    s.value2b(o.e);

    s.container4b(o.fs, 10);

}



using Buffer = std::vector;

using OutputAdapter = bitsery::OutputBufferAdapter;

using InputAdapter = bitsery::InputBufferAdapter;



int main() {

    MyStruct data{8941, MyEnum::V2, {15.0f, -8.5f, 0.045f}};

    MyStruct res{};



    Buffer buffer;



    auto writtenSize = bitsery::quickSerialization(buffer, data);

    auto state = bitsery::quickDeserialization({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 `` 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).