lzma_index_record Struct Reference

Index Record and its location. More...

#include <index.h>

Data Fields

lzma_vli total_size
 Total encoded size of a Block including Block Padding.
lzma_vli unpadded_size
 Encoded size of a Block excluding Block Padding.
lzma_vli uncompressed_size
 Uncompressed Size of a Block.
lzma_vli stream_offset
 Compressed offset in the Stream(s).
lzma_vli uncompressed_offset
 Uncompressed offset.

Detailed Description

Index Record and its location.


Field Documentation

Total encoded size of a Block including Block Padding.

This value is useful if you need to know the actual size of the Block that the Block decoder will read.

Referenced by set_info().

Encoded size of a Block excluding Block Padding.

This value is stored in the Index. When doing random-access reading, you should give this value to the Block decoder along with uncompressed_size.

Referenced by set_info().

Uncompressed Size of a Block.

Referenced by set_info().

Compressed offset in the Stream(s).

This is the offset of the first byte of the Block, that is, where you need to seek to decode the Block. The offset is relative to the beginning of the Stream, or if there are multiple Indexes combined, relative to the beginning of the first Stream.

Referenced by set_info().

Uncompressed offset.

When doing random-access reading, it is possible that the target offset is not exactly at Block boundary. One will need to compare the target offset against uncompressed_offset, and possibly decode and throw away some amount of data before reaching the target offset.

Referenced by set_info().


The documentation for this struct was generated from the following file:

Generated on Mon Dec 21 22:54:41 2009 for XZ Utils by  doxygen 1.6.1