Phosphor
Qt6 / Wayland library suite for window-management tools
 
Loading...
Searching...
No Matches
PhosphorFsLoader::ParsedEntry Struct Reference

One parsed file's payload + metadata. More...

#include <phosphor-fsloader/include/PhosphorFsLoader/ParsedEntry.h>

Public Attributes

QString key
 Registry key. Usually the JSON "name" field; sink-defined.
 
QString sourcePath
 Absolute path of the source file on disk.
 
QString systemSourcePath
 Set by the loader when this entry overrides an earlier-scanned one (user-wins-over-system on collision).
 
std::any payload
 Sink-owned payload (the parsed curve / profile / etc.).
 

Detailed Description

One parsed file's payload + metadata.

Returned by IDirectoryLoaderSink::parseFile and passed back to the same sink's commitBatch. The payload is type-erased via std::any so the loader library stays schema-agnostic — the sink produces it, the sink consumes it, nobody in between peeks.

Member Data Documentation

◆ key

QString PhosphorFsLoader::ParsedEntry::key

Registry key. Usually the JSON "name" field; sink-defined.

◆ payload

std::any PhosphorFsLoader::ParsedEntry::payload

Sink-owned payload (the parsed curve / profile / etc.).

The sink that produced it is the sink that consumes it — safe to std::any_cast to the expected concrete type.

◆ sourcePath

QString PhosphorFsLoader::ParsedEntry::sourcePath

Absolute path of the source file on disk.

◆ systemSourcePath

QString PhosphorFsLoader::ParsedEntry::systemSourcePath

Set by the loader when this entry overrides an earlier-scanned one (user-wins-over-system on collision).

Empty otherwise.

INTROSPECTION METADATA ONLY — restore-on-delete is implemented by the rescan itself: when the user copy is removed, the next rescan re-parses the system file fresh and commits it as the authoritative entry, with systemSourcePath cleared. Sinks do not (and should not) consult this field at commit time to "restore" a system entry — there is nothing to restore, the system file has always been on disk and always gets re-parsed.

Kept so UI code (settings browsers, layout managers) can show "your file shadows the system default at /path/to/system.json" to users without re-walking the system directory.


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