index.h File Reference

Handling of Index. More...

Go to the source code of this file.

Macros
#define	UNPADDED_SIZE_MIN   LZMA_VLI_C(5)
	Minimum Unpadded Size.
#define	UNPADDED_SIZE_MAX   (LZMA_VLI_MAX & ~LZMA_VLI_C(3))
	Maximum Unpadded Size.
#define	INDEX_INDICATOR   0
	Index Indicator based on xz specification.

Functions
uint32_t	lzma_index_padding_size (const lzma_index *i)
void	lzma_index_prealloc (lzma_index *i, lzma_vli records)

Detailed Description

Handling of Index.

Note

This header file does not include common.h or lzma.h because this file is needed by both liblzma internally and by the tests. Including common.h will include and define many things the tests do not need and prevents issues with header file include order. This way, if lzma.h or common.h are not included before this file it will break on every OS instead of causing more subtle errors.

Macro Definition Documentation

INDEX_INDICATOR

#define INDEX_INDICATOR   0

Index Indicator based on xz specification.

UNPADDED_SIZE_MAX

#define UNPADDED_SIZE_MAX   (LZMA_VLI_MAX & ~LZMA_VLI_C(3))

Maximum Unpadded Size.

UNPADDED_SIZE_MIN

#define UNPADDED_SIZE_MIN   LZMA_VLI_C(5)

Minimum Unpadded Size.

Function Documentation

lzma_index_padding_size()

uint32_t lzma_index_padding_size ( const lzma_index * i )

extern

Get the size of the Index Padding field. This is needed by Index encoder and decoder, but applications should have no use for this.

lzma_index_prealloc()

void lzma_index_prealloc ( lzma_index * i, lzma_vli records )

extern

Set for how many Records to allocate memory the next time lzma_index_append() needs to allocate space for a new Record. This is used only by the Index decoder.