Struct BookSync 

pub struct BookSync<E, P = ()> { /* private fields */ }

Synchronization state of one subscribed book.

Implementations

impl<E: Clone, P> BookSync<E, P>

pub fn new(now: Instant) -> Self

Creates a book waiting for its first snapshot.

pub fn phase(&self) -> &BookPhase<P>

Returns the synchronization phase.

pub fn position(&self) -> Option<&P>

Returns the venue position of the last accepted frame while synced.

pub fn is_current(&self, recovery: &Arc<BookRecovery<E>>) -> bool

Returns whether recovery is the book’s current episode.

pub fn has_pending_snapshot(&self) -> bool

Returns whether a snapshot wait or deadline is pending.

pub fn is_send_pending(&self) -> bool

Returns whether a guarded subscription write is still in flight.

pub fn expect_snapshot(&mut self, gate: SnapshotGate) -> CancellationToken

Records the initial snapshot wait for a subscription whose write gate guards.

Accepting a snapshot, claiming a recovery, or removing the book cancels the returned token.

pub fn accept_snapshot(&mut self, position: P, now: Instant) -> bool

Accepts a snapshot at position unless a subscription write or recovery gate blocks it.

pub fn advance(&mut self, position: P, now: Instant) -> bool

Advances a synced book to position, returning false when the book is not synced.

pub fn gap(&mut self) -> BookSequenceOutcome

Marks the book out of sync after a gap, an incremental while unsynced, or an invalid snapshot.

Returns BookSequenceOutcome::Recover when neither a running recovery nor an armed snapshot deadline owns the book; the adapter then claims a recovery. The result grants no ownership, so later calls return Recover again until the adapter claims one.

pub fn claim(&mut self) -> Option<Arc<BookRecovery<E>>>

Claims a recovery episode, refusing while another is running.

The claimed episode owns the book and retires any pending snapshot wait. Cancel it if its task cannot start, or it keeps the book owned with nothing running.

pub fn reject(&self, error: E) -> bool

Delivers error to the running recovery, returning false when none is running.

pub fn reset_on_reconnect(&mut self)

Restarts synchronization after the book’s connection reconnects.

An initial subscription write still in flight keeps its snapshot wait, since reconnect replay may not include it yet. A running recovery keeps running with its budget; BookRecoveryState::reset_on_reconnect describes when the reconnect wakes it.

pub fn arm_deadline(&mut self, deadline: Instant) -> bool

Arms a snapshot deadline, returning false while an initial snapshot wait is in flight.

pub fn take_expired(&mut self, now: Instant) -> bool

Removes an expired snapshot deadline, returning whether one expired.

pub fn stale(&mut self, threshold: Duration, now: Instant) -> Option<Duration>

Returns how long the book has gone without an accepted frame once that exceeds threshold, re-arming the window so a dead feed is reported once per threshold.

A book owned by a running recovery is not reported; the recovery logs its own attempts.

Trait Implementations

impl<E: Debug, P: Debug> Debug for BookSync<E, P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.