Struct sync_test::sync15::TestStore

pub struct TestStore {
    pub name: &'static str,
    pub test_records: RefCell<Vec<TestRecord>>,
    pub store_sync_assoc: RefCell<StoreSyncAssociation>,
    pub was_reset_called: Cell<bool>,
    pub global_id: Option<Guid>,
    pub coll_id: Option<Guid>,
}

Fields

name: &'static str

test_records: RefCell<Vec<TestRecord>>

store_sync_assoc: RefCell<StoreSyncAssociation>

was_reset_called: Cell<bool>

global_id: Option<Guid>

coll_id: Option<Guid>

Trait Implementations

impl Store for TestStore

fn collection_name(&self) -> Cow<'static, str>

fn apply_incoming(
    &self,
    inbound: Vec<IncomingChangeset>,
    _telem: &mut Engine
) -> Result<OutgoingChangeset>

inbound is a vector to support the case where get_collection_requests returned multiple requests. The changesets are in the same order as the requests were -- e.g. if vec![req_a, req_b] was returned from get_collection_requests, inbound will have the results from req_a as its first index, and those from req_b as it's second.

fn sync_finished(
    &self,
    _new_timestamp: ServerTimestamp,
    records_synced: Vec<Guid>
) -> Result<()>

fn get_collection_requests(
    &self,
    _server_timestamp: ServerTimestamp
) -> Result<Vec<CollectionRequest>>

The store is responsible for building the collection request. Engines typically will store a lastModified timestamp and use that to build a request saying "give me full records since that date" - however, other engines might do something fancier. This could even later be extended to handle "backfills" etc

fn get_sync_assoc(&self) -> Result<StoreSyncAssociation>

This is where we return our test collection's sync ID (and global sync ID).

fn reset(&self, assoc: &StoreSyncAssociation) -> Result<()>

Reset the store without wiping local data, ready for a "first sync". assoc defines how this store is to be associated with sync.

fn wipe(&self) -> Result<()>

fn prepare_for_sync(&self, _get_client_data: &dyn Fn()) -> Result<(), Error>

Prepares the store for syncing. The tabs store currently uses this to store the current list of clients, which it uses to look up device names and types.