Expand description
Transcript binary serialization (.brkt format).
A transcript is a serialized Vec<OutputPart> — the append-only log of
all output parts produced during story execution. Combined with an .inkb
program and optional .inkl locale data, a transcript can be re-rendered
in any language without re-executing the story.
§Binary format
Header (16 bytes):
b"BRKT" magic (4)
u16 LE version = 1 (2)
u16 LE reserved (2)
u32 LE source_checksum (4)
u32 LE content CRC-32 (4)
Body:
u32 LE part count
[Part]* encoded partsStructs§
- Transcript
Data - A decoded transcript: the output parts, the source program’s checksum (to verify compatibility before rendering), and the captured fragments (for re-rendering choice display text and computed substrings).
Enums§
- Transcript
Error - Errors from transcript serialization/deserialization.
Functions§
- read_
transcript - Deserialize a transcript from the
.brktbinary format. - render_
transcript - Re-render a transcript against the given line tables.
- write_
transcript - Serialize a transcript to the
.brktbinary format.