Skip to content

Commit

Permalink
Vain cosmetic changes
Browse files Browse the repository at this point in the history
  • Loading branch information
mccolljr committed Dec 19, 2023
1 parent 8404cdb commit 58b2f80
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "serde-sibor"
version = "0.1.0"
edition = "2021"
resolver = "2"
description = "A serde implementation of the SIBOR binary format"
description = "A serde implementation of the SiBOR binary format"
readme = "README.md"
repository = "https://github.com/mccolljr/serde-sibor"
license = "MPL-2.0"
Expand Down
26 changes: 13 additions & 13 deletions README.md
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.
20 changes: 10 additions & 10 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
#![forbid(unsafe_code)]
//! # `serde` implementation for the SIBOR binary format.
//! # `serde` implementation for the SiBOR binary format.
//!
//! SIBOR is a binary format that is designed to be simple to implement, fast to encode and decode,
//! 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 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.
//! 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.

/// Deserialization types and functions.
Expand Down

0 comments on commit 58b2f80

Please sign in to comment.