Struct kitchen_fridge::provider::Provider

pub struct Provider<L, T, R, U> where
    L: CalDavSource<T>,
    T: CompleteCalendar + Sync + Send,
    R: CalDavSource<U>,
    U: DavCalendar + Sync + Send,  { /* fields omitted */ }

A data source that combines two CalDavSources, which is able to sync both sources.

Usually, you will only need to use a provider between a server and a local cache, that is to say a CalDavProvider, i.e. a Provider<Cache, CachedCalendar, Client, RemoteCalendar>.
However, providers can be used for integration tests, where the remote source is mocked by a Cache.

Implementations

impl<L, T, R, U> Provider<L, T, R, U> where
    L: CalDavSource<T>,
    T: CompleteCalendar + Sync + Send,
    R: CalDavSource<U>,
    U: DavCalendar + Sync + Send, 

pub fn new(remote: R, local: L) -> Self

Create a provider.

remote is usually a Client, local is usually a Cache. However, both can be interchangeable. The only difference is that remote always wins in case of a sync conflict

pub fn local(&self) -> &L

Returns the data source described as local

pub fn local_mut(&mut self) -> &mut L

Returns the data source described as local

pub fn remote(&self) -> &R

Returns the data source described as remote.

Apart from tests, there are very few (if any) reasons to access remote directly. Usually, you should rather use the local source, which (usually) is a much faster local cache. To be sure local accurately mirrors the remote source, you can run Provider::sync

pub async fn sync_with_feedback(
    &mut self,
    feedback_sender: FeedbackSender
) -> bool

Performs a synchronisation between local and remote, and provide feeedback to the user about the progress.

This bidirectional sync applies additions/deletions made on a source to the other source. In case of conflicts (the same item has been modified on both ends since the last sync, remote always wins).

It returns whether the sync was totally successful (details about errors are logged using the log::* macros). In case errors happened, the sync might have been partially executed but your data will never be correupted (either locally nor in the server). Simply run this function again, it will re-start a sync, picking up where it failed.

pub async fn sync(&mut self) -> bool

Performs a synchronisation between local and remote, without giving any feedback.

See Self::sync_with_feedback

Trait Implementations

impl<L: Debug, T: Debug, R: Debug, U: Debug> Debug for Provider<L, T, R, U> where
    L: CalDavSource<T>,
    T: CompleteCalendar + Sync + Send,
    R: CalDavSource<U>,
    U: DavCalendar + Sync + Send, 

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

Formats the value using the given formatter.