Struct SyncEngine 

pub struct SyncEngine { /* private fields */ }

The sync engine orchestrates synchronization between local state and a remote sequencer.

This is the Rust equivalent of the JS SyncEngine class, providing:

• Event recording to the outbox
• Push (outbox -> remote) via a Transport
• Pull (remote -> buffer) via a Transport
• Conflict resolution during pull
• Status reporting

Examples

use stateset_sync::{SyncEngine, SyncConfig, SyncEvent};
use serde_json::json;

let config = SyncConfig::new("agent-1", "tenant-1", "store-1");
let mut engine = SyncEngine::new(config).expect("valid sync config");

let seq = engine.record(SyncEvent::new("order.created", "order", "ORD-1", json!({"total": 99})));
assert!(seq.is_ok());
assert_eq!(engine.pending_count(), 1);

Implementations

impl SyncEngine

pub fn new(config: SyncConfig) -> Result<Self, SyncError>

Create a new SyncEngine with the given configuration.

Errors

Returns SyncError::InvalidConfig for invalid settings or SyncError::Storage when durable outbox initialization fails.

pub fn with_strategy( config: SyncConfig, strategy: ConflictStrategy, ) -> Result<Self, SyncError>

Create a SyncEngine with a custom conflict resolution strategy.

Errors

Returns SyncError::InvalidConfig for invalid settings or SyncError::Storage when durable outbox initialization fails.

pub fn try_new(config: SyncConfig) -> Result<Self, SyncError>

Fallible constructor that validates config and initializes persistence.

Errors

Returns SyncError::InvalidConfig for invalid settings or SyncError::Storage when durable outbox initialization fails.

pub fn try_with_strategy( config: SyncConfig, strategy: ConflictStrategy, ) -> Result<Self, SyncError>

Fallible constructor with explicit conflict strategy.

Errors

Returns SyncError::InvalidConfig for invalid settings or SyncError::Storage when durable outbox initialization fails.

pub fn record(&mut self, event: SyncEvent) -> Result<u64, SyncError>

Record an event into the outbox for later push.

Returns the assigned local sequence number.

Errors

Returns SyncError::OutboxFull if the outbox is at capacity.

pub async fn push( &mut self, transport: &dyn Transport, ) -> Result<PushResult, SyncError>

Push pending events from the outbox to the remote via the given transport.

Drains up to batch_size events from the outbox.

Errors

Returns SyncError::Transport if the transport operation fails.

pub async fn pull( &mut self, transport: &dyn Transport, ) -> Result<PullResult, SyncError>

Pull events from the remote sequencer into the local buffer.

Pulled events are added to the event buffer. If conflicts are detected (same entity_type + entity_id in both outbox and pulled), they are resolved using the configured strategy.

Errors

Returns SyncError::Transport if the transport operation fails.

pub fn status(&self) -> SyncStatus

Get the current sync status.

pub fn pending_count(&self) -> usize

Return the number of events pending in the outbox.

pub fn buffered_count(&self) -> usize

Return the number of events currently in the pull buffer.

pub fn drain_buffer(&mut self) -> Vec<SyncEvent>

Drain all events from the pull buffer.

pub const fn state(&self) -> &SyncState

Return a reference to the current sync state.

pub const fn config(&self) -> &SyncConfig

Return a reference to the sync configuration.

pub const fn resolver(&self) -> &ConflictResolver

Return a reference to the conflict resolver.

pub async fn full_sync( &mut self, transport: &dyn Transport, ) -> Result<(PushResult, PullResult), SyncError>

Perform a full sync: push first, then pull.

Errors

Returns the first error encountered during push or pull.

Trait Implementations

impl Debug for SyncEngine

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

Formats the value using the given formatter.