Skip to main content

Module payload

Module payload 

Source
Expand description

The payload an exporter plugin asked for with wants: bodies, resolved links and a hash on top of the compact view every plugin gets. Plugins that ask for nothing get the compact view.

Structs§

Wants
The extras a plugin can ask for in describe’s wants.

Functions§

docs
The documents in only with what w asks for; link spans are byte ranges in the body. Past budget bytes, bodies go as body_path for the plugin to read. A reference to a document left out is sent unresolved (reason: "not exported") so nothing about it reaches the plugin.
edges
Edges between documents in only.
visible
Which documents an export may show: committed ones, plus local ones with local.