lzma_index_iter::[struct].block Struct Reference

Data Fields
lzma_vli	number_in_file
	Block number in the file.
lzma_vli	compressed_file_offset
	Compressed start offset of this Block.
lzma_vli	uncompressed_file_offset
	Uncompressed start offset of this Block.
lzma_vli	number_in_stream
	Block number in this Stream.
lzma_vli	compressed_stream_offset
	Compressed start offset of this Block.
lzma_vli	uncompressed_stream_offset
	Uncompressed start offset of this Block.
lzma_vli	uncompressed_size
	Uncompressed size of this Block.
lzma_vli	unpadded_size
	Unpadded size of this Block.
lzma_vli	total_size
	Total compressed size.

Field Documentation

number_in_file

lzma_vli lzma_index_iter::[struct].block number_in_file

Block number in the file.

The first Block is 1.

compressed_file_offset

lzma_vli lzma_index_iter::[struct].block compressed_file_offset

Compressed start offset of this Block.

This offset is relative to the beginning of the lzma_index (i.e. usually the beginning of the .xz file). Normally this is where you should seek in the .xz file to start decompressing this Block.

uncompressed_file_offset

lzma_vli lzma_index_iter::[struct].block uncompressed_file_offset

Uncompressed start offset of this Block.

This offset is relative to the beginning of the lzma_index (i.e. usually the beginning of the .xz file).

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_file_offset or uncompressed_stream_offset, and possibly decode and throw away some amount of data before reaching the target offset.

number_in_stream

lzma_vli lzma_index_iter::[struct].block number_in_stream

Block number in this Stream.

The first Block is 1.

compressed_stream_offset

lzma_vli lzma_index_iter::[struct].block compressed_stream_offset

Compressed start offset of this Block.

This offset is relative to the beginning of the Stream containing this Block.

uncompressed_stream_offset

lzma_vli lzma_index_iter::[struct].block uncompressed_stream_offset

Uncompressed start offset of this Block.

This offset is relative to the beginning of the Stream containing this Block.

uncompressed_size

lzma_vli lzma_index_iter::[struct].block uncompressed_size

Uncompressed size of this Block.

You should pass this to the Block decoder if you will decode this Block. It will allow the Block decoder to validate the uncompressed size.

unpadded_size

lzma_vli lzma_index_iter::[struct].block unpadded_size

Unpadded size of this Block.

You should pass this to the Block decoder if you will decode this Block. It will allow the Block decoder to validate the unpadded size.

total_size

lzma_vli lzma_index_iter::[struct].block total_size

Total compressed size.

This includes all headers and padding in this Block. This is useful if you need to know how many bytes the Block decoder will actually read.

---

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