One chapter's coverage in library state. More...

#include <mdl_state.h>

Data Fields
char	chapter_id [k_mdl_chapter_id_max]
	Stable identifier (URL leaf).
char	source_url [k_mdl_url_max]
	Chapter page URL.
char	title [k_mdl_title_max]
	Display title, or empty.
double	number
	Parsed number; 0 may be valid.
bool	number_known
	Whether number is known.
uint16_t	page_count
	Total pages known (0 = ?).
uint16_t	pages_done
	Pages fetched and verified.
bool	complete
	All pages present + verified.
int64_t	fetched_at
	Completion time (epoch s).

Detailed Description

One chapter's coverage in library state.

Keyed by chapter_id (a parsed, sanitised identifier), NOT by position in a scraped list, so it stays valid as the site changes.

Invariant: pages_done <= page_count once page_count is known (> 0).; complete is true only after every page was fetched and verified.

See also: mdl_state_find_chapter

Since: 0.1.0

Definition at line 128 of file mdl_state.h.

Field Documentation

◆ chapter_id

char mdl_chapter_rec_t::chapter_id[k_mdl_chapter_id_max]

Stable identifier (URL leaf).

Definition at line 129 of file mdl_state.h.

Referenced by internal_mdl_state_emit_chapters(), mdl_state_add_chapter_numbered(), mdl_state_chapter_complete(), mdl_state_chapter_pages(), mdl_state_find_chapter(), and priv_mdl_state_valid().

◆ complete

bool mdl_chapter_rec_t::complete

All pages present + verified.

Definition at line 136 of file mdl_state.h.

Referenced by internal_export_fresh_separate(), internal_mdl_fetch_mark_complete(), internal_mdl_state_apply_chapter_values(), internal_mdl_state_complete_span(), internal_mdl_state_emit_chapters(), internal_mdl_state_has_complete_number(), mdl_state_chapter_complete(), mdl_state_coverage(), and priv_mdl_state_valid().

◆ fetched_at

int64_t mdl_chapter_rec_t::fetched_at

Completion time (epoch s).

Definition at line 137 of file mdl_state.h.

Referenced by internal_export_fresh_separate(), internal_mdl_fetch_mark_complete(), internal_mdl_state_apply_chapter_values(), and internal_mdl_state_emit_chapters().

◆ number

double mdl_chapter_rec_t::number

Parsed number; 0 may be valid.

Definition at line 132 of file mdl_state.h.

Referenced by internal_build_export_metadata(), internal_mdl_state_chapter_number_as_long(), internal_mdl_state_emit_chapters(), mdl_state_add_chapter_numbered(), mdl_state_set_chapter_metadata(), and priv_mdl_state_valid().

◆ number_known

bool mdl_chapter_rec_t::number_known

Whether number is known.

Definition at line 133 of file mdl_state.h.

Referenced by internal_build_export_metadata(), internal_mdl_state_chapter_number_as_long(), internal_mdl_state_emit_chapters(), mdl_state_add_chapter_numbered(), mdl_state_set_chapter_metadata(), and priv_mdl_state_valid().

◆ page_count

uint16_t mdl_chapter_rec_t::page_count

Total pages known (0 = ?).

Definition at line 134 of file mdl_state.h.

Referenced by internal_mdl_state_apply_chapter_values(), internal_mdl_state_emit_chapters(), mdl_state_chapter_pages(), and priv_mdl_state_valid().

◆ pages_done

uint16_t mdl_chapter_rec_t::pages_done

Pages fetched and verified.

Definition at line 135 of file mdl_state.h.

Referenced by internal_mdl_fetch_mark_complete(), internal_mdl_fetch_one_page(), internal_mdl_state_apply_chapter_values(), internal_mdl_state_emit_chapters(), and priv_mdl_state_valid().

◆ source_url

char mdl_chapter_rec_t::source_url[k_mdl_url_max]

Chapter page URL.

Definition at line 130 of file mdl_state.h.

Referenced by internal_build_export_metadata(), internal_mdl_state_emit_chapters(), mdl_state_add_chapter_numbered(), and priv_mdl_state_valid().

◆ title

char mdl_chapter_rec_t::title[k_mdl_title_max]

Display title, or empty.

Definition at line 131 of file mdl_state.h.

Referenced by internal_build_export_metadata(), internal_mdl_state_emit_chapters(), mdl_state_set_chapter_metadata(), and priv_mdl_state_valid().

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

apps/shared_libs/mdl/inc/mdl_state.h

Data Fields