Skip to main content

Module results

Module results 

Source
Expand description

Typed result payloads for the control methods.

Each struct is field-for-field identical to what dig-node emits (snake_case wire fields), so a client deserializes the node’s real response and re-serializes the same bytes — the property the conformance KATs pin. Genuinely open/proxied shapes (the updater beacon’s status, the peer-pool snapshot, the pairing list) stay serde_json::Value on the call’s Output rather than being frozen into a struct that would drift from the proxied source.

Structs§

CacheClearResult
control.cache.clear — the clear acknowledgement.
CacheView
The on-disk content-cache view (control.cache.get, and embedded in StatusResult).
CapsuleEntry
One cached capsule of a store, as listed by the hosted-stores methods.
ConfigResult
control.config.get — the node’s effective configuration.
HostedStore
One hosted/pinned store (control.hostedStores.list).
HostedStoreStatusResult
control.hostedStores.status — per-store pinned flag + cached capsules.
HostedStoresListResult
control.hostedStores.list — every held/pinned store.
ListSubscriptionsResult
control.listSubscriptions — the node’s persisted subscription set.
PairingApproveResult
control.pairing.approve — the mint acknowledgement + the new token’s id.
PairingPollResult
pairing.poll — the pairing poll outcome (OPEN, no token).
PairingRequestResult
pairing.request — the pairing handshake bootstrap (OPEN, no token).
PairingRevokeResult
control.pairing.revoke — the revoke acknowledgement.
PeersConnectResult
control.peers.connect — the connected peer’s id.
PeersDisconnectResult
control.peers.disconnect — the dropped peer’s id.
PinResult
control.hostedStores.pin — the pin acknowledgement + the pre-fetch outcome.
SetCapResult
control.cache.setCap — the applied cap (after the 64 MiB floor).
SetLevelResult
control.log.setLevel — the applied filter directive.
SetUpstreamResult
control.config.setUpstream — the persisted override + a restart hint.
StatusResult
control.status — a rich node status snapshot.
SubscribeResult
control.subscribe — the subscription acknowledgement.
SyncAvailability
The §21 sync availability flag embedded in StatusResult.
SyncStatusResult
control.sync.status — §21 sync availability + pin coverage.
SyncTriggerResult
control.sync.trigger — the synced-capsule outcome.
UnpinResult
control.hostedStores.unpin — the unpin acknowledgement + eviction count.
UnsubscribeResult
control.unsubscribe — the unsubscription acknowledgement.