Struct vdirsyncer::NamedPair

pub(crate) struct NamedPair<I: Item> {
    pub(crate) name: String,
    pub(crate) inner: StoragePair<I>,
    pub(crate) status_path: Utf8PathBuf,
    pub(crate) conflict_resolution: Option<RawCommand>,
    pub(crate) locks: (Arc<Mutex<()>>, Arc<Mutex<()>>),
    pub(crate) names: (String, String),
}

Pair with a name, as defined in the configuration file.

Fields

name: String

inner: StoragePair<I>

status_path: Utf8PathBuf

conflict_resolution: Option<RawCommand>

locks: (Arc<Mutex<()>>, Arc<Mutex<()>>)

Discretionary locks taken before using a storage. These MUST be sorted based on storage name to prevent possible deadlocks.

names: (String, String)

Implementations

impl<I: Item> NamedPair<I>

pub(crate) fn open_status_ro(&self) -> Result<Option<StatusDatabase>>

Returns None if the database doesn’t exist.

pub(crate) fn open_status_rw(&self) -> Result<StatusDatabase>

pub(crate) async fn daemon(self, interval: Duration) -> Error

Sync this pair indefinitely

Returns an error if an only if a fatal synchronisation error occurred.

pub(crate) async fn sync_once(self, dry_run: bool) -> Result<()>

pub(crate) async fn create_plan(&self) -> Result<Plan<I>>

Returns an error only if it is fatal.

If partial errors occurred during synchronisations, returns Ok(None).

pub(crate) async fn execute_plan(&self, plan: Plan<I>) -> Result<()>

pub(crate) async fn discover(&self) -> Result<()>

pub(crate) fn print_plan(&self, plan: &Plan<I>)

pub(crate) async fn resolve_conflicts(self, stdio: Arc<StdIo>) -> Result<()>