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, SDF compound files and the GPS logs of crate::formats::gps; and Detail, every format’s tab of the Info panel.

None of those formats can be scanned in place, so an open reads the file once, start to end, a piece at a time through its BatchReader, and writes its rows to temporary Arrow IPC segments (see crate::formats::segments) that the dataset scans lazily. Memory stays at one batch however long the file.

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.

Traits§

BatchReader
A text format’s reader: it takes the file a piece at a time and hands back its rows a batch at a time, keeping no more of the file than the batch.

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.