Skip to main content

Module text_formats

Module text_formats 

Source
Expand description

Text formats read into a table of their own: VCD value change dumps, FIX logs and SDF compound files, beside the GPS logs of crate::gps.

None can be scanned in place, so an open reads the file once, start to end, a piece at a time, and writes its rows to temporary Arrow IPC segments (see [crate::segments]) that the dataset scans lazily. Memory stays at one batch however long the file. What a file says besides its rows (a VCD header, the FIX dictionaries used, an SDF file’s fields) is a Detail for the Info panel.

Structs§

Detail
What a file says besides its rows, for its tab of the Info panel: a VCD header, the FIX dictionaries used, a model’s totals and metadata, an audio file’s format and markers. Every format’s tab is one of these, made by its reader when it opens.

Constants§

MAX_DETAIL_ROWS
The most rows of a Detail list; a file of more says how many are left out.

Functions§

tab
The name of format’s tab of the Info panel, as its descriptor says it: a reader names its Detail by this, so the descriptor is the one place that says it.