Parolin 0.7.9 6796
Console (soon DLLs) to do a tar like job
Loading...
Searching...
No Matches
lzma_stream_flags Struct Reference

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

#include <stream_flags.h>

Data Fields

uint32_t version
 Stream Flags format version.
 
lzma_vli backward_size
 Backward Size.
 
lzma_check check
 Check ID.
 
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.

Field Documentation

◆ backward_size

lzma_vli 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.

◆ check

lzma_check check

Check ID.

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

◆ reserved_bool1

lzma_bool reserved_bool1

Reserved member.

◆ reserved_bool2

lzma_bool reserved_bool2

Reserved member.

◆ reserved_bool3

lzma_bool reserved_bool3

Reserved member.

◆ reserved_bool4

lzma_bool reserved_bool4

Reserved member.

◆ reserved_bool5

lzma_bool reserved_bool5

Reserved member.

◆ reserved_bool6

lzma_bool reserved_bool6

Reserved member.

◆ reserved_bool7

lzma_bool reserved_bool7

Reserved member.

◆ reserved_bool8

lzma_bool reserved_bool8

Reserved member.

◆ reserved_enum1

lzma_reserved_enum reserved_enum1

Reserved member.

◆ reserved_enum2

lzma_reserved_enum reserved_enum2

Reserved member.

◆ reserved_enum3

lzma_reserved_enum reserved_enum3

Reserved member.

◆ reserved_enum4

lzma_reserved_enum reserved_enum4

Reserved member.

◆ reserved_int1

uint32_t reserved_int1

Reserved member.

◆ reserved_int2

uint32_t reserved_int2

Reserved member.

◆ version

uint32_t 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.

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 members 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.


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