We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent eb137b8 commit 728b7e6Copy full SHA for 728b7e6
1 file changed
python/tskit/metadata.py
@@ -201,6 +201,12 @@ class JSONStructCodec(AbstractMetadataCodec):
201
The codec expects a metadata schema with separate ``json`` and ``struct``
202
subschemas and produces a single dict containing the union of the keys from
203
those subschemas after decoding.
204
+
205
+ The structure of the encoded metadata is as follows: first, a fixed-size
206
+ header that contains the number of bytes for both ``json`` and ``struct``
207
+ portions; next, the json; then a variable number of zeroed padding bytes
208
+ that brings the length to a multiple of 8 for alignment; and finally
209
+ the struct-encoded binary portion.
210
"""
211
212
MAGIC = b"JBLB"
0 commit comments