XZ Utils 5.4.1
Data Fields
lzma_outbuf_s Struct Reference

Data Fields

lzma_outbufnext
 
void * worker
 
size_t allocated
 
size_t pos
 
size_t decoder_in_pos
 
bool finished
 
lzma_ret finish_ret
 
lzma_vli unpadded_size
 
lzma_vli uncompressed_size
 
uint8_t buf []
 Buffer of "allocated" bytes. More...
 

Field Documentation

◆ next

lzma_outbuf* lzma_outbuf_s::next

Pointer to the next buffer. This is used for the cached buffers. The worker thread must not modify this.

◆ worker

void* lzma_outbuf_s::worker

This initialized by lzma_outq_get_buf() and is used by lzma_outq_enable_partial_output(). The worker thread must not modify this.

Referenced by lzma_outq_enable_partial_output().

◆ allocated

size_t lzma_outbuf_s::allocated

Amount of memory allocated for buf[]. The worker thread must not modify this.

◆ pos

size_t lzma_outbuf_s::pos

Writing position in the worker thread or, in other words, the amount of finished data written to buf[] which can be copied out

Note
This is read by another thread and thus access to this variable needs a mutex.

Referenced by lzma_outq_is_readable().

◆ decoder_in_pos

size_t lzma_outbuf_s::decoder_in_pos

Decompression: Position in the input buffer in the worker thread that matches the output "pos" above. This is used to detect if more output might be possible from the worker thread: if it has consumed all its input, then more output isn't possible.

Note
This is read by another thread and thus access to this variable needs a mutex.

◆ finished

bool lzma_outbuf_s::finished

True when no more data will be written into this buffer.

Note
This is read by another thread and thus access to this variable needs a mutex.

Referenced by lzma_outq_enable_partial_output(), and lzma_outq_is_readable().

◆ finish_ret

lzma_ret lzma_outbuf_s::finish_ret

Return value for lzma_outq_read() when the last byte from a finished buffer has been read. Defaults to LZMA_STREAM_END. This must not be LZMA_OK. The idea is to allow a decoder to pass an error code to the main thread, setting the code here together with finished = true.

◆ unpadded_size

lzma_vli lzma_outbuf_s::unpadded_size

Additional size information. lzma_outq_read() may read these when "finished" is true.

◆ buf

uint8_t lzma_outbuf_s::buf[]

Buffer of "allocated" bytes.


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