Skip to main content

Module api

Module api 

Source
Expand description

Driver-facing API shapes (JSON-able), mirroring the conformance ClientInstance contract: sync reports, conflicts, rejections, row states, subscription states. Serialized as camelCase to cross the shim boundary unchanged.

Structs§

ClientLimits
Client limits (§4.2 request knobs).
ConflictRecord
LeaseState
§7.3.5: the client’s opaque auth-lease state — leaseId/expiresAtMs from the last LEASE frame, and errorCode once a round was rejected with a request-level lease code (stop-and-surface; no data purge).
PresencePeer
§8.6 a peer’s ephemeral presence document on a scope key.
RejectionRecord
RowState
SchemaFloor
SubscriptionStateView
SyncReport
WindowBase
§4.8 window base: one table, the scope variable whose values are the window units, any fixed scopes shared by every unit, and host-opaque params carried onto each unit’s subscription.

Enums§

Mutation
One local mutation (§6.1 shapes, schema-agnostic local form per §0).
SyncOutcome
sync() never panics or errors out-of-band: transport and protocol failures come back as Failed (the driver’s { ok: false }).