ZXC 0.15.0
High-performance asymmetric lossless compression library
Loading...
Searching...
No Matches
zxc_outbuf_t Struct Reference

Output buffer descriptor for push streaming. More...

#include <zxc_pstream.h>

Data Fields

void * dst
 Caller-owned output region.
 
size_t size
 Total capacity available at dst.
 
size_t pos
 Bytes already produced by the library (in/out).
 

Detailed Description

Output buffer descriptor for push streaming.

The caller provides a writable region of capacity size at dst. The library writes from dst+pos and advances pos by what it produced; the caller drains [dst, dst+pos) and resets pos to 0 between rounds (or grows size).

Treat the ENTIRE region [dst+pos, dst+size) as scratch: when the remaining capacity allows it the decoder writes blocks straight into it with speculative (wild-copy) stores, so bytes past the final pos are unspecified after a call. Never leave live data inside the declared capacity.

Definition at line 100 of file zxc_pstream.h.

Field Documentation

◆ dst

void* zxc_outbuf_t::dst

Caller-owned output region.

Definition at line 101 of file zxc_pstream.h.

Referenced by zxc_cstream_compress(), zxc_dstream_decompress(), and zxc_outbuf_push().

◆ pos

size_t zxc_outbuf_t::pos

Bytes already produced by the library (in/out).

Definition at line 103 of file zxc_pstream.h.

Referenced by zxc_cstream_compress(), zxc_dstream_decompress(), and zxc_outbuf_push().

◆ size

size_t zxc_outbuf_t::size

Total capacity available at dst.

Definition at line 102 of file zxc_pstream.h.

Referenced by zxc_cstream_compress(), zxc_dstream_decompress(), and zxc_outbuf_push().


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