Struct StoredStateSeriesReader 

pub struct StoredStateSeriesReader { /* private fields */ }

Reader that reconstructs complete in-memory series from one completed recording.

Construction consumes the decoder registry so decoder configuration and metadata remain one coherent read authority. The type is intentionally non-Clone because registered decoders may not have meaningful clone semantics.

Implementations

impl StoredStateSeriesReader

pub fn open_completed_recording( root: impl AsRef<Path>, decoders: JsonPayloadDecoderRegistry, ) -> Result<Self, StorageError>

Opens one recording directory and validates its authoritative metadata.

The metadata snapshot must declare successful completion. Reading an active or failed recording is deliberately rejected because its chunk inventory is not a complete analysis result.

Decoder coverage is checked per selected stream by StoredStateSeriesReader::read_stream_as_state_series, allowing one registry to serve only the streams an analysis intends to load.

Errors

Returns StorageError::Io when metadata.json cannot be read, StorageError::Json when it is not syntactically valid JSON, semantic metadata errors from internal RecordingMetadata::validate, or StorageError::RecordingNotComplete unless status is complete.

pub fn recording_directory(&self) -> &Path

Returns the recording directory exactly as supplied at construction.

pub fn stream_names(&self) -> impl ExactSizeIterator<Item = &str>

Iterates declared stream names in deterministic metadata order.

pub fn format_version(&self) -> u32

Returns the validated storage format version.

pub fn user_metadata(&self) -> &Map<String, Value>

Borrows immutable metadata supplied when recording began.

pub fn terminal_metadata(&self) -> &Map<String, Value>

Borrows values committed only at successful completion.

pub fn recording_timing(&self) -> &RecordingTiming

Borrows automatic operational timing for the completed recording.

pub fn stream_record_count(&self, stream: &str) -> Result<u64, StorageError>

Returns the metadata-declared record count for one completed stream.

pub fn stream_encoded_bytes(&self, stream: &str) -> Result<u64, StorageError>

Returns the exact metadata-declared encoded bytes for one stream.

pub fn read_stream_as_state_series( &self, stream: &str, ) -> Result<StateSeries, StorageError>

Reconstructs one named logical stream as a complete StateSeries.

The method validates decoder coverage before opening chunk files. It then checks every chunk’s filesystem length, processes its complete JSONL records in order, verifies descriptor record/index facts and SHA-256, and appends only fully decoded states to the private series.

Errors

Returns precise stream-selection, decoder, filesystem, integrity, record, payload-conversion, or series-invariant errors. No partially reconstructed series is returned on failure.

pub fn read_all_streams_as_state_series( &self, ) -> Result<Vec<(String, StateSeries)>, StorageError>

Reconstructs every declared stream in metadata order.

Distinct stream schemas and sampling intervals remain distinct series. If any stream fails, already reconstructed series are dropped and no partial vector is returned.

pub fn read_latest_state_from_stream( &self, stream: &str, ) -> Result<SystemState, StorageError>

Reconstructs only the latest state in one completed stream.

Earlier chunks are not opened. The newest chunk’s length and checksum are verified, then its final newline-terminated record is decoded into the stream’s partial schema. This is suitable for final-value analysis; use checkpoint continuation when the state must cover a complete model schema and remain appendable.

Trait Implementations

impl Debug for StoredStateSeriesReader

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

Formats bounded configuration without decoder internals or payloads.