1 unstable release

0.1.0 Dec 18, 2023

#1685 in Encoding

24 downloads per month

MPL-2.0 license

38KB
1K SLoC

serde-sibor

serde implementation for the SIBOR binary format.

What is SIBOR?

SIBOR is a binary format that is designed to be simple to implement, fast to encode and decode, and relatively compact. In order to achieve these goals, the number of features is kept to a minimum, and some types are not supported:

  • SIBOR is not self-describing. The schema must be known in advance.
  • SIBOR does not have a concept of "optional" fields. All fields must have a value.
  • SIBOR does not support maps. All maps must be encoded as sequences of key-value pairs.
  • SIBOR treats all signed integers, unsigned integers, and floats as 64-bit values.
  • SIBOR encodes all unsigned integers using a variable-length encoding.
  • SIBOR encodes all signed integers using a variable-length zigzag encoding.
  • SIBOR encodes all floats using a 64-bit IEEE 754 encoding. The bits are treated as a u64 and encoded using the variable-length encoding.

SIBOR is meant to be used when you want a quick and dirty way to serialize and deserialize binary data of a known schema. It does not have any built-in support for schema evolution, so such support must be implemented by the user.

Dependencies

~0.4–1MB
~23K SLoC