RawJson Namespace Reference

Classes
struct	SetDataRange
	The byte extent of a set's object inside the scanned document, plus the size of its cards array. This is the slice SetToDownload needs for lazy per-set parsing; the metadata strings live in SetRange alongside it. More...
struct	SetRange
struct	ScanError

Typedefs
using	ScanProgressCallback = std::function<void(qsizetype bytesRead, qsizetype totalBytes)>
	Optional progress callback receiving (bytesRead, totalBytes) while the document is walked. Invoked from the scanning thread; the caller decides how the throttled offsets are relayed to a GUI event loop.

Functions
QList< SetRange >	scanSetRanges (const QByteArray &json, ScanError *error=nullptr, const ScanProgressCallback &progress=ScanProgressCallback())
	Scans a full MTGJSON document without materializing the JSON tree.

Typedef Documentation

ScanProgressCallback

using RawJson::ScanProgressCallback = std::function<void(qsizetype bytesRead, qsizetype totalBytes)>

Optional progress callback receiving (bytesRead, totalBytes) while the document is walked. Invoked from the scanning thread; the caller decides how the throttled offsets are relayed to a GUI event loop.

Function Documentation

scanSetRanges()

QList< SetRange > RawJson::scanSetRanges	(	const QByteArray &	json,
		ScanError *	error = nullptr,
		const ScanProgressCallback &	progress = ScanProgressCallback() )

Scans a full MTGJSON document without materializing the JSON tree.

Splits the top-level "data" object into per-set byte ranges and reads each set's metadata directly from the raw bytes. The Oracle importer can then parse one set at a time during import, keeping peak memory far below a single QJsonDocument::fromJson() over the whole file.

The whole document is structurally validated while scanning (strings, escapes, braces, and a trailing-content check) and nesting depth is capped at 1024 to match QJsonDocument, so pathologically deep documents fail shallowly instead of exhausting the stack. Verdicts agree with QJsonDocument::fromJson on structurally malformed input; unlike Qt, string metadata fields ("name", "type", "releaseDate", "code") tolerate null / non-string values by defaulting to empty rather than rejecting the whole document, so one broken set cannot abort the import of the rest.

Following QJsonDocument::fromJson's convention, the parsed ranges are returned by value and any failure is reported through the error out parameter.

Parameters

json	The raw MTGJSON document bytes.
error	Out parameter. Set to an error ScanError when the document cannot be parsed, otherwise left empty. Passing a null pointer disables error reporting.
progress	Optional progress callback. When non-empty it is invoked as the scanner advances through the document, throttled to a tiny fraction of the total size.

Returns

The detected per-set ranges, or an empty list on failure.

Here is the call graph for this function:

Here is the caller graph for this function: