liblzma (XZ Utils) 5.4.4
Data Fields
lzma_stream Struct Reference

Passing data to and from liblzma. More...

#include <base.h>

Data Fields

const uint8_t * next_in
 
size_t avail_in
 
uint64_t total_in
 
uint8_t * next_out
 
size_t avail_out
 
uint64_t total_out
 
const lzma_allocatorallocator
 Custom memory allocation functions.
 
lzma_internalinternal
 
uint64_t seek_pos
 New seek input position for LZMA_SEEK_NEEDED.
 

Detailed Description

Passing data to and from liblzma.

The lzma_stream structure is used for

Typical usage:

Application may modify the values of total_in and total_out as it wants. They are updated by liblzma to match the amount of data read and written but aren't used for anything else except as a possible return values from lzma_get_progress().

Field Documentation

◆ next_in

const uint8_t* lzma_stream::next_in

Pointer to the next input byte.

◆ avail_in

size_t lzma_stream::avail_in

Number of available input bytes in next_in.

◆ total_in

uint64_t lzma_stream::total_in

Total number of bytes read by liblzma.

◆ next_out

uint8_t* lzma_stream::next_out

Pointer to the next output position.

◆ avail_out

size_t lzma_stream::avail_out

Amount of free space in next_out.

◆ total_out

uint64_t lzma_stream::total_out

Total number of bytes written by liblzma.

◆ allocator

const lzma_allocator* lzma_stream::allocator

Custom memory allocation functions.

In most cases this is NULL which makes liblzma use the standard malloc() and free().

Note
In 5.0.x this is not a const pointer.

◆ internal

lzma_internal* lzma_stream::internal

Internal state is not visible to applications.

◆ seek_pos

uint64_t lzma_stream::seek_pos

New seek input position for LZMA_SEEK_NEEDED.

When lzma_code() returns LZMA_SEEK_NEEDED, the new input position needed by liblzma will be available seek_pos. The value is guaranteed to not exceed the file size that was specified when this lzma_stream was initialized.

In all other situations the value of this variable is undefined.


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