rabook_import_cfg_t Struct Reference

Injected dependencies + versioning for rabook_import_open. More...

#include <rabook_import.h>

Collaboration diagram for rabook_import_cfg_t:

Data Fields
ra8_fs_mount_t *	mount
	Mounted FAT volume (cache + source).
rabook_import_compile_fn	compile
	Compile-on-miss seam (non-NULL).
void *	compile_ctx
	Cookie forwarded to compile.
uint8_t *	scratch
	Streaming buffer for the source CRC.
uint32_t	scratch_cap
	Capacity of scratch in bytes.
uint32_t	format_version
	.rabook format version stamp.
uint32_t	importer_version
	Importer/compiler version stamp.

Detailed Description

Injected dependencies + versioning for rabook_import_open.

Open/Closed seam: the manager owns no globals; every external collaborator (the volume, the compiler, the streaming scratch) is passed in. format_version and importer_version are the two stamps that gate reuse – pass k_book_format_version and the firmware's compiler revision so a build that changes the format or the compiler transparently re-derives stale caches.

Invariant

mount, compile, and scratch are non-NULL; scratch_cap > 0.

Since

Version 0.1.0

Definition at line 162 of file rabook_import.h.

Field Documentation

compile

rabook_import_compile_fn rabook_import_cfg_t::compile

Compile-on-miss seam (non-NULL).

Definition at line 164 of file rabook_import.h.

Referenced by imp_make_cfg(), and internal_compile_and_cache().

compile_ctx

void* rabook_import_cfg_t::compile_ctx

Cookie forwarded to compile.

Definition at line 165 of file rabook_import.h.

Referenced by imp_make_cfg(), and internal_compile_and_cache().

format_version

uint32_t rabook_import_cfg_t::format_version

.rabook format version stamp.

Definition at line 168 of file rabook_import.h.

Referenced by imp_make_cfg(), and rabook_import_open().

importer_version

uint32_t rabook_import_cfg_t::importer_version

Importer/compiler version stamp.

Definition at line 169 of file rabook_import.h.

Referenced by imp_make_cfg(), and rabook_import_open().

mount

ra8_fs_mount_t* rabook_import_cfg_t::mount

Mounted FAT volume (cache + source).

Definition at line 163 of file rabook_import.h.

Referenced by imp_make_cfg(), internal_compile_and_cache(), internal_validate_open_args(), and rabook_import_open().

scratch

uint8_t* rabook_import_cfg_t::scratch

Streaming buffer for the source CRC.

Definition at line 166 of file rabook_import.h.

Referenced by imp_make_cfg(), and rabook_import_open().

scratch_cap

uint32_t rabook_import_cfg_t::scratch_cap

Capacity of scratch in bytes.

Definition at line 167 of file rabook_import.h.

Referenced by imp_make_cfg(), and rabook_import_open().

---

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

• apps/shared_libs/rabook_import/inc/rabook_import.h