mdl_series_run_t Struct Reference

Parameters of one series download, as values rather than arguments. More...

#include <mdl_app.h>

Collaboration diagram for mdl_series_run_t:

Data Fields
const char *	cfg_path
	Site descriptor path.
const char *	series_url
	Series page URL.
const char *	out_dir
	Output library root.
const char *	cache_dir
	Per-host persistent cache root.
mdl_format_t	format
	Output container.
bool	combine
	Combine into one archive.
bool	update
	Incremental (skip complete).
bool	from_present
	Whether from_num applies.
double	from_num
	First chapter number to fetch.
size_t	chapters
	Max chapters (window mode).
uint64_t	seed
	Politeness jitter seed.
uint32_t	timeout
	Per-request budget, ms.
const mdl_run_opts_t *	opts
	Identity/security knobs.

Detailed Description

Parameters of one series download, as values rather than arguments.

Every field is either a validated scalar or a borrowed string the caller keeps alive for the run, so a form that has no command line can build one just as easily as one that does.

Invariant

out_dir and cache_dir are canonical absolute paths.

See also

mdl_app_run_series()

Since

0.1.0

Definition at line 114 of file mdl_app.h.

Field Documentation

cache_dir

const char* mdl_series_run_t::cache_dir

Per-host persistent cache root.

Definition at line 118 of file mdl_app.h.

Referenced by mdl_app_run_series().

cfg_path

const char* mdl_series_run_t::cfg_path

Site descriptor path.

Definition at line 115 of file mdl_app.h.

Referenced by internal_update_all_cb(), and mdl_app_run_series().

chapters

size_t mdl_series_run_t::chapters

Max chapters (window mode).

Definition at line 124 of file mdl_app.h.

Referenced by internal_select_run_window().

combine

bool mdl_series_run_t::combine

Combine into one archive.

Definition at line 120 of file mdl_app.h.

Referenced by internal_choose_layout().

format

mdl_format_t mdl_series_run_t::format

Output container.

Definition at line 119 of file mdl_app.h.

Referenced by internal_choose_layout(), and internal_export_after().

from_num

double mdl_series_run_t::from_num

First chapter number to fetch.

Definition at line 123 of file mdl_app.h.

Referenced by internal_select_run_window().

from_present

bool mdl_series_run_t::from_present

Whether from_num applies.

Definition at line 122 of file mdl_app.h.

Referenced by internal_select_run_window().

opts

const mdl_run_opts_t* mdl_series_run_t::opts

Identity/security knobs.

Definition at line 127 of file mdl_app.h.

Referenced by internal_export_after(), internal_make_ctx(), and mdl_app_run_series().

out_dir

const char* mdl_series_run_t::out_dir

Output library root.

Definition at line 117 of file mdl_app.h.

Referenced by mdl_app_run_series(), and mdl_app_run_update_all().

seed

uint64_t mdl_series_run_t::seed

Politeness jitter seed.

Definition at line 125 of file mdl_app.h.

Referenced by internal_run_prepared().

series_url

const char* mdl_series_run_t::series_url

Series page URL.

Definition at line 116 of file mdl_app.h.

Referenced by internal_make_ctx().

timeout

uint32_t mdl_series_run_t::timeout

Per-request budget, ms.

Definition at line 126 of file mdl_app.h.

Referenced by internal_make_ctx().

update

bool mdl_series_run_t::update

Incremental (skip complete).

Definition at line 121 of file mdl_app.h.

Referenced by internal_choose_layout(), internal_make_ctx(), and internal_select_run_window().

---

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

• apps/shared_libs/mdl/inc/mdl_app.h