Skip to content

Commit 02c61c3

Browse files
livingsilver94ermo
authored andcommitted
developers: stone: v1: payload-subheader: Document
1 parent 0c06a6c commit 02c61c3

2 files changed

Lines changed: 80 additions & 0 deletions

File tree

astro.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ export default defineConfig({
213213
items: [
214214
{ slug: "developers/stone/v1" },
215215
{ slug: "developers/stone/v1/header" },
216+
{ slug: "developers/stone/v1/payload-subheader" },
216217
{
217218
label: "Records",
218219
items: [
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: Payload's sub-header
3+
lastUpdated: 2026-04-22T00:00:00Z
4+
description: The content of Payload's sub-header
5+
---
6+
7+
Described below is the format of the 32-byte-long payload sub-header. This format is unique to v1.
8+
9+
<table>
10+
<tr>
11+
<th>Field</th>
12+
<th>Type</th>
13+
<th>Size (bytes)</th>
14+
<th>Description</th>
15+
</tr>
16+
<tr>
17+
<td>stored_size</td>
18+
<td>uint</td>
19+
<td>8</td>
20+
<td>
21+
Compressed size, in bytes, of the records.
22+
If records are not compressed, stored_size is equal to plain_size.
23+
</td>
24+
</tr>
25+
<tr>
26+
<td>plain_size</td>
27+
<td>uint</td>
28+
<td>8</td>
29+
<td>Uncompressed size, in bytes, of records.</td>
30+
</tr>
31+
<tr>
32+
<td>checksum</td>
33+
<td>blob</td>
34+
<td>8</td>
35+
<td>Checksum of records, computed using <a href="https://xxhash.com">XXH3_64bits</a>.</td>
36+
</tr>
37+
<tr>
38+
<td>num_records</td>
39+
<td>uint</td>
40+
<td>4</td>
41+
<td>Number of records contained in the payload.</td>
42+
</tr>
43+
<tr>
44+
<td>version</td>
45+
<td>uint</td>
46+
<td>2</td>
47+
<td>Version of the payload data format. Unused.</td>
48+
</tr>
49+
<tr>
50+
<td>record_kind</td>
51+
<td>uint</td>
52+
<td>1</td>
53+
<td>Kind of records that the payload contains.</td>
54+
</tr>
55+
<tr>
56+
<td>compression</td>
57+
<td>uint</td>
58+
<td>1</td>
59+
<td>Compression algorithm used for the records.</td>
60+
</tr>
61+
</table>
62+
63+
### record_kind
64+
65+
`record_kind` is an enum. The following table lists all possible values:
66+
67+
|Value|Name|
68+
|---|---|
69+
|1|<a href="/developers/stone/v1/record/meta">Meta</a>|
70+
|2|<a href="/developers/stone/v1/record/content">Content</a>|
71+
|3|<a href="/developers/stone/v1/record/layout">Layout</a>|
72+
|4|<a href="/developers/stone/v1/record/index">Index</a>|
73+
|5|<a href="/developers/stone/v1/record/attributes">Attributes</a>
74+
75+
### compression
76+
|Value|Name|
77+
|---|---|
78+
|1|Uncompressed|
79+
|2|Zstd|

0 commit comments

Comments
 (0)