mdl_rabook_vfs_t Struct Reference

One initialized strict validator or one open validated RBKC reader. More...

#include <mdl_rabook_vfs.h>

Collaboration diagram for mdl_rabook_vfs_t:

Data Fields
book_chunked_t	reader
	Bound RBKC reader.
book_header_t	header
	Strict decoded header.
ra8_io_vfs_file_t *	file
	Borrowed VFS facade slot.
book_inflate_fn	inflate_cb
	Caller inflater.
uint64_t *	table
	Caller table workspace.
uint8_t *	compressed
	Caller compressed staging.
uint8_t *	chunk
	Caller inflated chunk.
uint8_t *	scratch
	Caller strict workspace.
uint64_t	file_size
	Validated RBKC byte length.
uint8_t	digest [k_ra8_mdl_sha256_bytes]
	Transfer digest at validate.
uint32_t	table_cap
	Table entry capacity.
uint32_t	compressed_cap
	Compressed staging bytes.
uint32_t	chunk_cap
	Inflated chunk bytes.
uint32_t	scratch_cap
	Strict workspace bytes.
bool	open
	Live final-file reader.
bool	transfer_validated
	Stage validation succeeded.

Detailed Description

One initialized strict validator or one open validated RBKC reader.

Treat fields as private after mdl_rabook_vfs_init. Workspace pointers borrow the caller's storage; the VFS owns the opaque file facade.

Invariant

Between public calls, file != nullptr exactly while open is true; validation and open may hold a transient facade internally.

A true open means reader and header passed strict validation.

No member points to dynamically allocated first-party storage.

Since

0.1.0

Definition at line 73 of file mdl_rabook_vfs.h.

Field Documentation

chunk

uint8_t* mdl_rabook_vfs_t::chunk

Caller inflated chunk.

Definition at line 80 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_validate_open().

chunk_cap

uint32_t mdl_rabook_vfs_t::chunk_cap

Inflated chunk bytes.

Definition at line 86 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_validate_open().

compressed

uint8_t* mdl_rabook_vfs_t::compressed

Caller compressed staging.

Definition at line 79 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_open_reader().

compressed_cap

uint32_t mdl_rabook_vfs_t::compressed_cap

Compressed staging bytes.

Definition at line 85 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_open_reader().

digest

uint8_t mdl_rabook_vfs_t::digest[k_ra8_mdl_sha256_bytes]

Transfer digest at validate.

Definition at line 83 of file mdl_rabook_vfs.h.

Referenced by mdl_rabook_vfs_validate().

file

ra8_io_vfs_file_t* mdl_rabook_vfs_t::file

Borrowed VFS facade slot.

Definition at line 76 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_clear_open(), internal_rabook_close(), internal_rabook_open_reader(), internal_rabook_read_exact(), mdl_rabook_vfs_info(), mdl_rabook_vfs_open(), mdl_rabook_vfs_read_chunk(), and mdl_rabook_vfs_validate().

file_size

uint64_t mdl_rabook_vfs_t::file_size

Validated RBKC byte length.

Definition at line 82 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_clear_open(), internal_rabook_open_reader(), and mdl_rabook_vfs_validate().

header

book_header_t mdl_rabook_vfs_t::header

Strict decoded header.

Definition at line 75 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_clear_open(), mdl_rabook_vfs_info(), mdl_rabook_vfs_open(), and mdl_rabook_vfs_validate().

inflate_cb

book_inflate_fn mdl_rabook_vfs_t::inflate_cb

Caller inflater.

Definition at line 77 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_open_reader().

open

bool mdl_rabook_vfs_t::open

Live final-file reader.

Definition at line 88 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_clear_open(), mdl_rabook_vfs_info(), mdl_rabook_vfs_open(), mdl_rabook_vfs_read_chunk(), and mdl_rabook_vfs_validate().

reader

book_chunked_t mdl_rabook_vfs_t::reader

Bound RBKC reader.

Definition at line 74 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_clear_open(), internal_rabook_open_reader(), internal_rabook_validate_open(), mdl_rabook_vfs_info(), and mdl_rabook_vfs_read_chunk().

scratch

uint8_t* mdl_rabook_vfs_t::scratch

Caller strict workspace.

Definition at line 81 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_validate_open().

scratch_cap

uint32_t mdl_rabook_vfs_t::scratch_cap

Strict workspace bytes.

Definition at line 87 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_validate_open().

table

uint64_t* mdl_rabook_vfs_t::table

Caller table workspace.

Definition at line 78 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_open_reader().

table_cap

uint32_t mdl_rabook_vfs_t::table_cap

Table entry capacity.

Definition at line 84 of file mdl_rabook_vfs.h.

Referenced by internal_rabook_open_reader().

transfer_validated

bool mdl_rabook_vfs_t::transfer_validated

Stage validation succeeded.

Definition at line 89 of file mdl_rabook_vfs.h.

Referenced by mdl_rabook_vfs_validate().

---

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

• apps/shared_libs/mdl_storage_vfs/inc/mdl_rabook_vfs.h