Expand description
Scanning an ASDF file’s overall structure.
The layout is, in order: a #ASDF header line, optional comment lines, an
optional YAML tree, zero or more binary blocks, and an optional block
index. The tree’s length is deliberately not recorded anywhere, so that it
can be edited by hand; readers find its end by searching for the document
end marker.
Structs§
- Block
Location - Where a block lives in the file.
- Layout
- The result of scanning a file.
Enums§
- Index
Rejection - Why a block index was rejected.
Constants§
- ASDF_
HEADER_ PREFIX - The token every ASDF file starts with.
- ASDF_
STANDARD_ PREFIX - The comment that records the ASDF Standard version.
- BLOCK_
INDEX_ HEADER - The line that introduces the block index.
- YAML_
DIRECTIVE_ PREFIX - The prefix of the YAML version directive.
- YAML_
DOCUMENT_ END_ MARKER - The YAML document end marker, including its leading newline.
Functions§
- scan
- Scan an in-memory ASDF file.
- write_
block_ index - Render a block index for a set of blocks, as written at the end of a file.