One open tar archive: the backing plus the walk's running budget. More...

#include <unarch_tar.h>

Collaboration diagram for unarch_tar_t:

Data Fields
unarch_read_fn	read
	Byte reader over the archive.
void *	ctx
	Context for read.
uint64_t	size
	Archive length in bytes.
ra8_decomp_budget_t	budget
	Entry / iteration budget for the walk.
bool	live
	Open succeeded and not superseded.

Detailed Description

One open tar archive: the backing plus the walk's running budget.

Populated by unarch_tar_open; treat every field as read-only outside the API. The embedded budget accumulates across unarch_tar_next calls, so the policy's entry cap and iteration budget bound the whole enumeration, not one call.

Invariant: read != NULL and live between a successful open and close.; budget.limits is a validated policy.

See also: unarch_tar_open()

Since: Version 0.1.0

Definition at line 97 of file unarch_tar.h.

Field Documentation

◆ budget

ra8_decomp_budget_t unarch_tar_t::budget

Entry / iteration budget for the walk.

Definition at line 101 of file unarch_tar.h.

Referenced by internal_finish_member(), unarch_tar_next(), and unarch_tar_open().

◆ ctx

void* unarch_tar_t::ctx

Context for read.

Definition at line 99 of file unarch_tar.h.

Referenced by internal_meta_consume(), internal_read_block(), unarch_tar_open(), and unarch_tar_read().

◆ live

bool unarch_tar_t::live

Open succeeded and not superseded.

Definition at line 102 of file unarch_tar.h.

Referenced by comic_close(), priv_comic_cbt_extract(), priv_comic_cbt_open(), unarch_tar_next(), unarch_tar_open(), and unarch_tar_read().

◆ read

unarch_read_fn unarch_tar_t::read

Byte reader over the archive.

Definition at line 98 of file unarch_tar.h.

Referenced by internal_meta_consume(), internal_read_block(), unarch_tar_open(), and unarch_tar_read().

◆ size

uint64_t unarch_tar_t::size

Archive length in bytes.

Definition at line 100 of file unarch_tar.h.

Referenced by internal_finish_member(), internal_read_block(), unarch_tar_next(), unarch_tar_open(), and unarch_tar_read().

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

apps/shared_libs/unarch/inc/unarch_tar.h