Options for encoding/decoding Stream Header and Stream Footer. More...

#include <stream_flags.h>

Public Attributes
uint32_t	version
	Stream Flags format version. More...

lzma_vli	backward_size
	Backward Size. More...

lzma_check	check
	Check ID. More...

lzma_reserved_enum	reserved_enum1

lzma_reserved_enum	reserved_enum2

lzma_reserved_enum	reserved_enum3

lzma_reserved_enum	reserved_enum4

lzma_bool	reserved_bool1

lzma_bool	reserved_bool2

lzma_bool	reserved_bool3

lzma_bool	reserved_bool4

lzma_bool	reserved_bool5

lzma_bool	reserved_bool6

lzma_bool	reserved_bool7

lzma_bool	reserved_bool8

uint32_t	reserved_int1

uint32_t	reserved_int2

Detailed Description

Options for encoding/decoding Stream Header and Stream Footer.

Definition at line 33 of file stream_flags.h.

Member Data Documentation

◆ backward_size

lzma_vli lzma_stream_flags::backward_size

Backward Size.

Backward Size must be a multiple of four bytes. In this Stream format version, Backward Size is the size of the Index field.

Backward Size isn't actually part of the Stream Flags field, but it is convenient to include in this structure anyway. Backward Size is present only in the Stream Footer. There is no need to initialize backward_size when encoding Stream Header.

lzma_stream_header_decode() always sets backward_size to LZMA_VLI_UNKNOWN so that it is convenient to use lzma_stream_flags_compare() when both Stream Header and Stream Footer have been decoded.

Definition at line 69 of file stream_flags.h.

Referenced by LZMA_API(), main(), parse_indexes(), stream_decode(), stream_encode_mt(), test_decode_invalid(), test_encode_invalid(), and test_header_decoder().

◆ check

lzma_check lzma_stream_flags::check

Check ID.

This indicates the type of the integrity check calculated from uncompressed data.

Definition at line 79 of file stream_flags.h.

Referenced by stream_decode(), stream_decoder_get_check(), stream_encoder_mt_init(), test_decode_invalid(), test_encode_invalid(), and worker_encode().

◆ reserved_bool1

lzma_bool lzma_stream_flags::reserved_bool1

Definition at line 94 of file stream_flags.h.

◆ reserved_bool2

lzma_bool lzma_stream_flags::reserved_bool2

Definition at line 95 of file stream_flags.h.

◆ reserved_bool3

lzma_bool lzma_stream_flags::reserved_bool3

Definition at line 96 of file stream_flags.h.

◆ reserved_bool4

lzma_bool lzma_stream_flags::reserved_bool4

Definition at line 97 of file stream_flags.h.

◆ reserved_bool5

lzma_bool lzma_stream_flags::reserved_bool5

Definition at line 98 of file stream_flags.h.

◆ reserved_bool6

lzma_bool lzma_stream_flags::reserved_bool6

Definition at line 99 of file stream_flags.h.

◆ reserved_bool7

lzma_bool lzma_stream_flags::reserved_bool7

Definition at line 100 of file stream_flags.h.

◆ reserved_bool8

lzma_bool lzma_stream_flags::reserved_bool8

Definition at line 101 of file stream_flags.h.

◆ reserved_enum1

lzma_reserved_enum lzma_stream_flags::reserved_enum1

Definition at line 90 of file stream_flags.h.

◆ reserved_enum2

lzma_reserved_enum lzma_stream_flags::reserved_enum2

Definition at line 91 of file stream_flags.h.

◆ reserved_enum3

lzma_reserved_enum lzma_stream_flags::reserved_enum3

Definition at line 92 of file stream_flags.h.

◆ reserved_enum4

lzma_reserved_enum lzma_stream_flags::reserved_enum4

Definition at line 93 of file stream_flags.h.

◆ reserved_int1

uint32_t lzma_stream_flags::reserved_int1

Definition at line 102 of file stream_flags.h.

◆ reserved_int2

uint32_t lzma_stream_flags::reserved_int2

Definition at line 103 of file stream_flags.h.

◆ version

uint32_t lzma_stream_flags::version

Stream Flags format version.

To prevent API and ABI breakages if new features are needed in Stream Header or Stream Footer, a version number is used to indicate which fields in this structure are in use. For now, version must always be zero. With non-zero version, the lzma_stream_header_encode() and lzma_stream_footer_encode() will return LZMA_OPTIONS_ERROR.

lzma_stream_header_decode() and lzma_stream_footer_decode() will always set this to the lowest value that supports all the features indicated by the Stream Flags field. The application must check that the version number set by the decoding functions is supported by the application. Otherwise it is possible that the application will decode the Stream incorrectly.

Definition at line 51 of file stream_flags.h.

Referenced by LZMA_API(), parse_indexes(), stream_encode(), stream_encoder_init(), and stream_encoder_mt_init().

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

subprojects/xz-5.2.5/src/liblzma/api/lzma/stream_flags.h

Public Attributes