Struct couchbase_lite::Replicator

pub struct Replicator { /* private fields */ }

Replicator of database

Implementations

impl Replicator

pub fn new<StateCallback, DocumentsEndedCallback, ValidationF>( db: &Database, url: &str, params: ReplicatorParameters<StateCallback, DocumentsEndedCallback, ValidationF> ) -> Result<Self, Error>where ValidationF: ReplicatorValidationFunction, StateCallback: ReplicatorStatusChangedCallback, DocumentsEndedCallback: ReplicatorDocumentsEndedCallback,

Arguments

• url - should be something like “ws://192.168.1.132:4984/demo/”
• params - parameters of replicator

pub fn start(&mut self, reset: bool) -> Result<(), Error>

starts database replication

• reset - If true, the replicator will reset its checkpoint and start replication from the beginning.

pub fn restart( self, db: &Database, url: &str, auth: &ReplicatorAuthentication, reset: bool ) -> Result<Self, Error>

Full recreation of database replicator except callbacks,

• url - new url
• auth - new auth information
• reset - If true, the replicator will reset its checkpoint and start replication from the beginning.

pub fn retry(&mut self) -> Result<bool, Error>

Tells a replicator that’s in the offline state to reconnect immediately. return true if the replicator will reconnect, false if it won’t.

pub fn stop(&mut self)

pub fn state(&self) -> ReplicatorState

Trait Implementations

impl Drop for Replicator

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Replicator

it should be safe to call replicator API from any thread according to https://github.com/couchbase/couchbase-lite-core/wiki/Thread-Safety