Struct RecordReader 

pub struct RecordReader { /* private fields */ }

Reader for a recorded test run.

Provides access to the metadata and events stored during a test run. The archive is opened lazily when methods are called.

Implementations

impl RecordReader

pub fn open(run_dir: &Utf8Path) -> Result<Self, RecordReadError>

Opens a recorded run from its directory.

The directory should contain store.zip and run.log.zst.

pub fn run_dir(&self) -> &Utf8Path

Returns the path to the run directory.

pub fn read_cargo_metadata(&mut self) -> Result<String, RecordReadError>

Returns the cargo metadata JSON from the archive.

pub fn read_test_list(&mut self) -> Result<TestListSummary, RecordReadError>

Returns the test list from the archive.

pub fn read_record_opts(&mut self) -> Result<RecordOpts, RecordReadError>

Returns the record options from the archive.

pub fn read_rerun_info(&mut self) -> Result<Option<RerunInfo>, RecordReadError>

Returns the rerun info from the archive, if this is a rerun.

Returns Ok(None) if this run is not a rerun (the file doesn’t exist). Returns Err if the file exists but cannot be read or parsed.

pub fn load_dictionaries(&mut self) -> Result<(), RecordReadError>

Loads the dictionaries from the archive.

This must be called before reading output files. The dictionaries are used for decompressing test output.

Note: The store format version is checked before opening the archive, using the store_format_version field in runs.json.zst. This method assumes the version has already been validated.

pub fn events(&self) -> Result<RecordEventIter, RecordReadError>

Returns an iterator over events in the run log.

Events are read one at a time from the zstd-compressed JSON Lines file.

pub fn read_output( &mut self, file_name: &str, ) -> Result<Vec<u8>, RecordReadError>

Reads output for a specific file from the archive.

The file_name should be the value from ZipStoreOutput::file_name, e.g., “test-abc123-1-stdout”.

The OutputFileName type ensures that file names are validated during deserialization, preventing path traversal.

Panics

Panics if load_dictionaries has not been called first.

Trait Implementations

impl Debug for RecordReader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StoreReader for RecordReader

fn read_cargo_metadata(&mut self) -> Result<String, RecordReadError>

Returns the cargo metadata JSON from the store.

fn read_test_list(&mut self) -> Result<TestListSummary, RecordReadError>

Returns the test list summary from the store.

fn read_record_opts(&mut self) -> Result<RecordOpts, RecordReadError>

Returns the record options from the store.

fn read_rerun_info(&mut self) -> Result<Option<RerunInfo>, RecordReadError>

Returns the rerun info from the store, if this is a rerun.

fn load_dictionaries(&mut self) -> Result<(), RecordReadError>

Loads the dictionaries from the store.

fn read_output(&mut self, file_name: &str) -> Result<Vec<u8>, RecordReadError>

Reads output for a specific file from the store.

fn extract_file_to_path( &mut self, store_path: &str, output_path: &Utf8Path, ) -> Result<u64, RecordReadError>

Extracts a file from the store to a path, streaming directly.