@xviz_hk/io v1.0.8

@xviz_hk/io Overview

This module aims at being the central IO library for reading, writing, and manipulating xviz_hk data.

This module is separated in the following layers.

xviz_hk Data classes

xviz_hk data classes strive to remove the need to understand and handle the various formats that xviz_hk data can be stored.

Sources and Sinks

Sources and Sinks are a simple abstraction to write and read data. We provide synchronous File and Memory implementations.

Readers and Writers

Readers and Writers are the objects that deal with writing out the actual xviz_hk data. At this level the objects know about any implementation details that are not covered by the xviz_hk specification, such as the use of an index file or the specific identifiers used to store xviz_hk in a particular format.

Providers

xviz_hk Providers are a level above Readers and Writers where a Provider interface only deals with metadata and messages and providing access to that data.