-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
24 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
[![crates.io](https://img.shields.io/crates/v/serde-sibor.svg)](https://crates.io/crates/serde-sibor) | ||
|
||
# `serde-sibor` | ||
#### `serde` implementation for the SIBOR binary format. | ||
#### `serde` implementation for the SiBOR binary format. | ||
|
||
#### What is SIBOR? | ||
#### 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 (**Si**mple **B**inary **O**bject **R**epresentation) 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 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. | ||
- 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. | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters