txtdot/dalet
1
0
Fork 0
mirror of https://github.com/TxtDot/dalet.git synced 2024-10-16 11:48:06 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: remove str 3, add tag (id, argument)

Browse source
This commit is contained in:
Artemy Egorov 2024-07-27 19:11:11 +03:00
parent 9ccf27ef97
commit a0f68c4a42
1 changed files with 31 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
specification/daletpack.md
View file

@ -4,6 +4,8 @@ DaletPack is an binary data format for Dalet, that is used for minimizing the si
All data must be compressed in [Zstandard](https://datatracker.ietf.org/doc/html/rfc8878) format. All data must be compressed in [Zstandard](https://datatracker.ietf.org/doc/html/rfc8878) format.
Root data format is array of tags (see [Daletl specification](./daletl.md)), each element reads sequentially without type and size definition.
## Types (16) ## Types (16)
- **Null** - **Null**
@ -32,17 +34,17 @@ All data must be compressed in [Zstandard](https://datatracker.ietf.org/doc/html
| int | 1 | 0001 | | int | 1 | 0001 |
| str 3 | 2 | 0010 | | str 3 | 2 | 0010 |
| str 4 | 3 | 0011 | | str 4 | 3 | 0011 |
| str 6 | 4 | 0100 | | str 8 | 4 | 0100 |
| str 8 | 5 | 0101 | | str 16 | 5 | 0101 |
| str 16 | 6 | 0110 | | str 32 | 6 | 0110 |
| str 32 | 7 | 0111 | | arr 3 | 7 | 0111 |
| arr 3 | 8 | 1000 | | arr 4 | 8 | 1000 |
| arr 4 | 9 | 1001 | | arr 8 | 9 | 1001 |
| arr 8 | 10 | 1010 | | arr 16 | 10 | 1010 |
| arr 16 | 11 | 1011 | | arr 32 | 11 | 1011 |
| arr 32 | 12 | 1100 | | tag (id) | 12 | 1100 |
| tag (id) | 13 | 1101 | | tag (id, body) | 13 | 1101 |
| tag (id, body) | 14 | 1110 | | tag (id, argument) | 14 | 1110 |
| tag (id, body, argument) | 15 | 1111 | | tag (id, body, argument) | 15 | 1111 |
### Notation in diagrams ### Notation in diagrams
@ -93,24 +95,19 @@ str 4 (up to 15 bytes):
| 0011 | XXXX | data | | 0011 | XXXX | data |
+--------+------+========+ +--------+------+========+
str 6 (up to 63 bytes):
+--------+--------+========+
| 0100 | XXXXXX | data |
+--------+--------+========+
str 8 (up to 255 bytes): str 8 (up to 255 bytes):
+--------+----------+========+ +--------+----------+========+
| 0101 | XXXXXXXX | data | | 0100 | XXXXXXXX | data |
+--------+----------+========+ +--------+----------+========+
str 16 (up to 2^16-1 bytes): str 16 (up to 2^16-1 bytes):
+--------+----------+----------+========+ +--------+----------+----------+========+
| 0110 | XXXXXXXX | XXXXXXXX | data | | 0101 | XXXXXXXX | XXXXXXXX | data |
+--------+----------+----------+========+ +--------+----------+----------+========+
str 32 (up to 2^32-1 bytes): str 32 (up to 2^32-1 bytes):
+--------+----------+----------+----------+----------+========+ +--------+----------+----------+----------+----------+========+
| 0111 | XXXXXXXX | XXXXXXXX | XXXXXXXX | XXXXXXXX | data | | 0110 | XXXXXXXX | XXXXXXXX | XXXXXXXX | XXXXXXXX | data |
+--------+----------+----------+----------+----------+========+ +--------+----------+----------+----------+----------+========+
``` ```
@ -119,27 +116,27 @@ str 32 (up to 2^32-1 bytes):
```txt ```txt
arr 3 (up to 7 elements): arr 3 (up to 7 elements):
+--------+-----+~~~~~~~~+ +--------+-----+~~~~~~~~+
| 1000 | XXX | data | | 0111 | XXX | data |
+--------+-----+~~~~~~~~+ +--------+-----+~~~~~~~~+
arr 4 (up to 15 elements): arr 4 (up to 15 elements):
+--------+------+~~~~~~~~+ +--------+------+~~~~~~~~+
| 1001 | XXXX | data | | 1000 | XXXX | data |
+--------+------+~~~~~~~~+ +--------+------+~~~~~~~~+
arr 8 (up to 255 elements): arr 8 (up to 255 elements):
+--------+----------+~~~~~~~~+ +--------+----------+~~~~~~~~+
| 1010 | XXXXXXXX | data | | 1001 | XXXXXXXX | data |
+--------+----------+~~~~~~~~+ +--------+----------+~~~~~~~~+
arr 16 (up to 2^16-1 elements): arr 16 (up to 2^16-1 elements):
+--------+----------+----------+~~~~~~~~+ +--------+----------+----------+~~~~~~~~+
| 1011 | XXXXXXXX | XXXXXXXX | data | | 1010 | XXXXXXXX | XXXXXXXX | data |
+--------+----------+----------+~~~~~~~~+ +--------+----------+----------+~~~~~~~~+
arr 32 (up to 2^32-1 elements): arr 32 (up to 2^32-1 elements):
+--------+----------+----------+----------+----------+~~~~~~~~+ +--------+----------+----------+----------+----------+~~~~~~~~+
| 1100 | XXXXXXXX | XXXXXXXX | XXXXXXXX | XXXXXXXX | data | | 1011 | XXXXXXXX | XXXXXXXX | XXXXXXXX | XXXXXXXX | data |
+--------+----------+----------+----------+----------+~~~~~~~~+ +--------+----------+----------+----------+----------+~~~~~~~~+
``` ```
@ -151,16 +148,21 @@ Y = tag_id = XXXXX (5 bits) (can change before release)
tag (id): tag (id):
+--------+---+ +--------+---+
| 1101 | Y | | 1100 | Y |
+--------+---+ +--------+---+
tag (id, body): tag (id, body):
+--------+---+~~~~~~~~+ +--------+---+~~~~~~~~+
| 1110 | Y | data | | 1101 | Y | body |
+--------+---+~~~~~~~~+ +--------+---+~~~~~~~~+
tag (id, argument):
+--------+---+~~~~~~~~~~~~+
| 1101 | Y | argument |
+--------+---+~~~~~~~~~~~~+
tag (id, body, argument): tag (id, body, argument):
+--------+---+~~~~~~~~+~~~~~~~~+ +--------+---+~~~~~~~~+~~~~~~~~~~~~+
| 1111 | Y | data | data | | 1111 | Y | data | argument |
+--------+---+~~~~~~~~+~~~~~~~~+ +--------+---+~~~~~~~~+~~~~~~~~~~~~+
``` ```