Expand description
Committed Prost bindings and stable limits for peer and application protocols.
Regenerate with cargo run -p actordb-protocol --features codegen --bin generate.
Append -- --check to verify schema/binding agreement without writing files.
Modules§
- client
- meta
- write_
concern - Per-write acknowledgement policy and progress receipts. Acknowledgement thresholds do not establish a global mutation order.
Structs§
- Client
Decode Report - Work admitted before Prost or SDK receipt/result conversion allocates. Header charges include Vec geometric growth/minimum capacity and conservative map/portable-conversion storage. Payloads are charged twice for decoded and temporary validation copies. Caller-retained returned results, allocator slack, transport buffers and outgoing request storage are outside this scope.
- Client
Response Shape - Expectations derived from the actual pending application request, never from data echoed by the server. Use optional query shape from a trusted locally parsed plan; the protocol preflight does not parse SQL.
- Record
Version - A totally ordered hybrid-clock timestamp.
Enums§
- Client
Frame Kind - Exact message expected by the current application handshake/exchange phase.
Constants§
- CLIENT_
PROTOCOL_ VERSION - DEFAULT_
MAX_ DECODED_ RESPONSE_ BYTES - Default accounted response allowance, including raw framing, decoded collections/payloads and portable conversion work. Not an allocator/RSS cap.
- MAX_
BATCH_ ITEMS - MAX_
FRAME_ BYTES - MAX_
HANDSHAKE_ BYTES - PORTABLE_
CELL_ HEADER_ CHARGE - Conservative portable QueryValue header allowance. SDK tests check that their actual layout fits this charge without coupling the wire crate to SQL.
Functions§
- client_
auth_ proof - Canonical challenge proof. Client credentials use their own domain and never authenticate a peer. Both identities, offers, and fresh challenges are bound.
- preflight_
client_ frame - Validate before message/collection materialization using the default budget. The accounting/shape pass allocates no owned data. Malformed typed receipt validation can allocate a bounded error string before returning rejection.
- preflight_
client_ frame_ kind - preflight_
client_ frame_ with_ budget - As
preflight_client_frame, with an explicit accounted allowance and report. Successful preflight does not materialize messages, collections or payloads. - preflight_
client_ response - Additionally validate the actual pending request before materialization. The same bounded malformed-receipt error-metadata caveat applies.
- valid_
client_ hello - verify_
client_ auth