Crate hff_std

Implements the basic reader/writer functionality for HFF.

Structs

• ChunkCache
  Act as a ReadSeek IO object for purposes of having an entire HFF in memory at one time.
• ChunkIter
  Iterator over a table’s chunks.
• ChunkView
  A view to a chunk.
• DepthFirstIter
  A depth first iterator over hff content.
• Hff
  The Hff structure data. This is an immutable representation of the content of an Hff stream.
• TableBuilder
  Build a table.
• TableDesc
  A table description.
• TableIter
  An iterator over tables at a given level.
• TableView
  View of a table.

Traits

• DataSource
  A chunk data source.
• ReadSeek
  A wrapper trait with a blanket implementation for any type which supports both Read and Seek. The data source of the Hff must support this in order to retrieve metadata or chunk’s from the stream. If the stream is not Seek, either use the provided _full variation which will return the ChunkCache or otherwise store the entire file somewhere which can be accessed with Seek.
• StdWriter
  Extends the datasource to be able to write into a std::io::Write.

Functions

• read_stream
  Read a HFF from the given stream.
• read_stream_full
  Read a HFF from the given stream along with all the data for the chunks.
• table
  Create a table structure to be contained in the HFF. Panics if the given Ecc data is invalid.
• write_stream
  Write the table structure to an HFF container. NOTE: This does not support seek streams and as such any compressed chunks will need to be buffered in memory until written. Seek will allow deferral of the compression and reduce memory requirements. Support for seek and lazy header updates will be added later. NOTE: Currently this expects a single root table to encapsulate everything in the file. This is not a rule in the file format, it is simply how this is written.