Skip to main content

Module payload

Module payload 

Source
Expand description

JSON payload schema for shipping Best-in-Bag and Droptimizer results to a WoW addon.

Structs§

DecodeExportError
Errors raised by decode_result_export.
EncodeExportError
Errors raised by encode_result_export.
ResultExport
Top-level wowlab to addon export envelope (the inner JSON of a parcel).
ResultItem
A single exported item row, carrying enough identity to reconstruct a WoW item: link.

Enums§

DecodeExportErrorKind 🔒
EncodeExportErrorKind 🔒
ExportKind
What kind of result is being exported.

Constants§

RESULT_EXPORT_CONTENT_TYPE
Content-type token used inside the envelope.
RESULT_EXPORT_PREFIX
Wire-format prefix for the result export envelope; trailing digit is the version.
RESULT_EXPORT_SCHEMA_VERSION
Schema version embedded in the JSON payload, distinct from the wire prefix version.

Functions§

decode_result_export
Inverse of encode_result_export.
encode_result_export
Serialise export to JSON and wrap it in a parcel envelope as a single ASCII string.
result_export_codec
Build a codec preconfigured for wowlab result exports.