Module protocol

Expand description

Versioned wire types shared by the remote client and reference server.

Structs§

DeleteRequest: Request to compare-and-swap delete a memory.
ErrorResponse: Error response returned for a failed protocol operation.
ExportCursor: Exclusive position in deterministic (namespace, id) export order.
ExportRequest: Request for one deterministic snapshot export page.
ExportResponse: One deterministic snapshot export page.
ListResponse: Response containing a bounded deterministic window of visible records.
PutRequest: Request to insert or compare-and-swap replace a memory.
PutResponse: Response to PutRequest.
ReadRequest: Request to read unversioned IDs and versioned keys.
ReadResponse: Response containing requested current records.
ScanRequest: Request for semantic retrieval.
ScanResponse: Response to ScanRequest.
SessionResponse: Session negotiation result.
SyncReport: Counts produced by applying an authoritative namespace snapshot.
SyncRequest: Authoritative full snapshot for one authenticated namespace.

BOOKMARK_HEADER: Header carrying an opaque server-issued bookmark between requests.
DELETE_PATH: Compare-and-swap deletion route.
EXPORT_PATH: Paginated server snapshot export route.
LIST_PATH: Visible-record listing route.
MAX_BOOKMARK_BYTES: Maximum UTF-8 bytes accepted in a bookmark.
MAX_EXPORT_PAGE_RECORDS: Maximum records returned by one export page.
MAX_NAMESPACE_BYTES: Maximum UTF-8 bytes accepted in a namespace.
NAMESPACE_HEADER: Header carrying the authenticated namespace on every request.
PUT_PATH: Direct mutation route.
READ_PATH: Record-read route.
SCAN_PATH: Semantic scan route.
SESSION_PATH: Session-negotiation route.
SYNC_PATH: Authoritative namespace snapshot route.

is_valid_bookmark: Returns whether an opaque bookmark is non-empty and bounded.
is_valid_namespace: Returns whether a namespace is non-empty, bounded, and URL/header safe.