Struct OptimisticQueue 

pub struct OptimisticQueue { /* private fields */ }

A local optimistic replica plus the confirmed baseline it can rebuild from.

The transport must treat ActionId as an idempotency key. Accepted actions are incorporated into the confirmed baseline by Self::acknowledge, so authoritative snapshots passed to Self::merge_authoritative must not also echo still-pending actions. Buffer such a snapshot until its client action acknowledgements have settled, or send unrelated host changes as a separate Automerge delta.

Implementations

impl OptimisticQueue

pub fn new(live: &mut AutoCommit) -> OptimisticQueue

Begin at live’s current committed state. Pending open Automerge ops are committed by get_heads so the baseline is unambiguous.

pub fn submit<A>( &mut self, live: &mut AutoCommit, action: &A, encoded: EncodedAction, ) -> Result<ActionEnvelope, OptimisticError>

where A: Action,

Apply now, return the envelope to send, and remember it until the host accepts or rejects it.

Errors

Returns OptimisticError::LiveDiverged for out-of-session writes, or an action/Automerge error when local application fails.

pub fn submit_by<A>( &mut self, live: &mut AutoCommit, action: &A, encoded: EncodedAction, actor: Option<&[u8]>, ) -> Result<ActionEnvelope, OptimisticError>

where A: Action,

Self::submit with an explicit history actor.

Errors

Returns the same errors as Self::submit.

pub fn acknowledge( &mut self, id: ActionId, registry: &ActionRegistry, ) -> Result<Acknowledgement, OptimisticError>

Mark one reply accepted. Out-of-order replies remain marked until all predecessors are accepted; the confirmed replica then advances through the contiguous prefix in order.

Errors

Returns a decode/application error or OptimisticError::ConfirmationBaseMismatch without advancing the confirmed baseline.

pub fn reject( &mut self, live: &mut AutoCommit, id: ActionId, registry: &ActionRegistry, ) -> Result<RebaseBatch, OptimisticError>

Remove a refused action, roll the live replica back to confirmed state, and replay every survivor with fresh ids/base heads. The caller sends the returned replacements and cancels/ignores superseded ids.

Errors

Returns a decode or action-application error. The queue and live document remain unchanged on failure.

pub fn merge_authoritative( &mut self, live: &mut AutoCommit, authoritative: &mut AutoCommit, registry: &ActionRegistry, ) -> Result<RebaseBatch, OptimisticError>

Merge a host replica into the confirmed baseline, then rebase pending work on top. With no pending work the live replica simply becomes the merged confirmed state. See the type-level transport contract before merging a snapshot that contains this client’s accepted actions.

Errors

Returns an Automerge merge error or a pending-action replay error. The queue and live document remain unchanged on failure.

pub fn reconnect_batch(&self) -> Vec<ActionEnvelope>

Envelopes to resend after reconnect. No local replay occurs: their optimistic effects are already present in live.

pub fn pending_len(&self) -> usize

pub fn is_settled(&self) -> bool

pub fn confirmed(&self) -> &AutoCommit

Read-only confirmed state, useful for connection/status UI and tests.

pub fn confirmed_heads(&self) -> Vec<ChangeHash>

The causal heads of the host-confirmed baseline.

pub fn is_superseded(&self, id: ActionId) -> bool