mdl_format.h File Reference

Shared media artifact format contract for download and export paths. More...

#include <stdint.h>

Include dependency graph for mdl_format.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	mdl_format_t : uint8_t {   k_mdl_format_loose = 0U ,   k_mdl_format_cbz = 1U ,   k_mdl_format_cbt = 2U ,   k_mdl_format_cbr = 3U ,   k_mdl_format_cbt_xz = 4U ,   k_mdl_format_cbt_gz = 5U ,   k_mdl_format_epub = 6U ,   k_mdl_format_jof = 7U ,   k_mdl_format_rabook = 8U ,   k_mdl_format_invalid = 255U }
	Artifact format selected by a media-download composition root. More...

Detailed Description

Shared media artifact format contract for download and export paths.

Tag

[Ring 4 / Domain] {World: NS}

This type names the artifact the RA8 application will actually publish. It is deliberately separate from the C6 raw-HTTPS transport protocol: selecting RABOOK means the RA8-side exporter must build, validate, and transactionally commit a .rabook; it never means that a transport backend may merely relabel downloaded bytes.

Copyright

Copyright (c) 2026 Brighton Sikarskie SPDX-License-Identifier: MIT

Since

0.1.0

Definition in file mdl_format.h.

Enumeration Type Documentation

mdl_format_t

enum mdl_format_t : uint8_t

Artifact format selected by a media-download composition root.

Values cover every current host exporter so the same selection can be carried into firmware composition without depending on CLI-only headers. Reserved values remain explicit and cannot be mistaken for implemented writers.

Invariant

k_mdl_format_rabook selects the strict RBKC/RABOOK1 writer.

Since

0.1.0

Enumerator
k_mdl_format_loose	Leave loose page images.
k_mdl_format_cbz	ZIP of images (.cbz).
k_mdl_format_cbt	Tar of images (.cbt).
k_mdl_format_cbr	Reserved RAR output.
k_mdl_format_cbt_xz	Reserved xz-compressed tar output.
k_mdl_format_cbt_gz	Gzip-compressed tar (.cbt.gz).
k_mdl_format_epub	Fixed-layout EPUB (.epub).
k_mdl_format_jof	Native JOF tile atlas per page (.jof).
k_mdl_format_rabook	Chunked reader-native book (.rabook).
k_mdl_format_invalid	Unrecognized or unsupported selection.

Definition at line 35 of file mdl_format.h.