unarch_xz_stream_t Struct Reference

One multi-call XZ decode session (opaque decoder + liveness flag). More...

#include <unarch_xz.h>

Data Fields
struct xz_dec *	dec
	xz-embedded decoder state (pool-allocated).
bool	live
	Session is begun and not yet ended.

Detailed Description

One multi-call XZ decode session (opaque decoder + liveness flag).

Bound by unarch_xz_stream_begin over a caller scratch; dec points into that scratch (via the XZ pool) and is owned by the session until unarch_xz_stream_end. Treat the fields as read-only outside this module.

Invariant

dec != NULL exactly while live is true.

At most one session exists at a time (single-client pool).

Example:

unarch_xz_stream_t xs = {};
ra8_err_t err = unarch_xz_stream_begin(&xs, scratch, sizeof(scratch));
// ... feed via unarch_xz_stream_run ...
unarch_xz_stream_end(&xs);

See also

unarch_xz_stream_begin()

Since

Version 0.1.0

Definition at line 98 of file unarch_xz.h.

Field Documentation

dec

struct xz_dec* unarch_xz_stream_t::dec

xz-embedded decoder state (pool-allocated).

Definition at line 99 of file unarch_xz.h.

Referenced by unarch_xz_stream_begin(), unarch_xz_stream_end(), and unarch_xz_stream_run().

live

bool unarch_xz_stream_t::live

Session is begun and not yet ended.

Definition at line 100 of file unarch_xz.h.

Referenced by unarch_xz_stream_begin(), unarch_xz_stream_end(), and unarch_xz_stream_run().

---

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

• apps/shared_libs/unarch/inc/unarch_xz.h