Struct SyncClient 

pub struct SyncClient {
    api_configurations: Arc<ApiConfigurations>,
    sync_handlers: HandlerRegistry<dyn SyncHandler>,
    error_handlers: HandlerRegistry<dyn SyncErrorHandler>,
    sync_lock: Mutex<()>,
    last_sync: Option<Setting<DateTime<Utc>>>,
}

Client for performing sync operations with event support

This client wraps the core sync functionality and provides hooks for registering event handlers that can respond to sync operations.

Fields

api_configurations: Arc<ApiConfigurations>

sync_handlers: HandlerRegistry<dyn SyncHandler>

error_handlers: HandlerRegistry<dyn SyncErrorHandler>

sync_lock: Mutex<()>

last_sync: Option<Setting<DateTime<Utc>>>

Implementations

impl SyncClient

pub fn new(client: Client) -> SyncClient

Create a new SyncClient from a Bitwarden client

pub async fn last_sync(&self) -> Option<DateTime<Utc>>

Get the timestamp of the last successful sync or confirmed-up-to-date skip, if any.

pub fn register_sync_handler(&self, handler: Arc<dyn SyncHandler>)

Register a sync handler for sync operations

Handlers are called in registration order. If any handler returns an error, the sync operation is aborted immediately and subsequent handlers are not called.

pub fn register_error_handler(&self, handler: Arc<dyn SyncErrorHandler>)

Register an error handler for sync operations

Error handlers are called when any error occurs during sync, including API errors and handler errors. All error handlers are always called regardless of individual failures.

pub async fn sync(&self, request: SyncRequest) -> Result<bool, SyncError>

Perform a sync operation, skipping the server call when nothing has changed.

Returns Ok(true) if a full sync was performed, or Ok(false) if the revision-date check determined that the server has no new changes and the sync was skipped.

Control flow

Unless request.force is true, this method first fetches the account revision date from the server and compares it to the stored last_sync timestamp. If the revision is not newer, the sync is skipped: last_sync is bumped to now and Ok(false) is returned without calling any sync or error handlers.

When a full sync is performed:

1. Fetches the full sync response from the Bitwarden API.
2. Dispatches on_sync with the response to all registered handlers in order; stops on the first handler error.
3. Dispatches on_sync_complete to all handlers for post-processing.
4. On success, bumps last_sync to now and returns Ok(true).

Errors

Any error (revision-date fetch, API call, or handler failure) is forwarded to all registered error handlers before being returned to the caller. last_sync is never bumped on an error path.