kitchen-freezer/src/traits.rs

use std::error::Error;

use async_trait::async_trait;
use url::Url;
use chrono::{DateTime, Utc};

use crate::Calendar;

#[async_trait]
pub trait CalDavSource {
    /// Returns the current calendars that this source contains
    /// This function may trigger an update (that can be a long process, or that can even fail, e.g. in case of a remote server)
    async fn get_calendars(&self) -> Result<&Vec<Calendar>, Box<dyn Error>>;
    /// Returns the current calendars that this source contains
    /// This function may trigger an update (that can be a long process, or that can even fail, e.g. in case of a remote server)
    async fn get_calendars_mut(&mut self) -> Result<Vec<&mut Calendar>, Box<dyn Error>>;

    //
    //
    // TODO: find a better search key (do calendars have a unique ID?)
    // TODO: search key should be a reference
    //
    /// Returns the calendar matching the URL
    async fn get_calendar(&self, url: Url) -> Option<&Calendar>;
    /// Returns the calendar matching the URL
    async fn get_calendar_mut(&mut self, url: Url) -> Option<&mut Calendar>;

}

pub trait SyncSlave {
    /// Returns the last time this source successfully synced from a master source (e.g. from a server)
    /// (or None in case it has never been synchronized)
    fn get_last_sync(&self) -> Option<DateTime<Utc>>;
    /// Update the last sync timestamp to now, or to a custom time in case `timepoint` is `Some`
    fn update_last_sync(&mut self, timepoint: Option<DateTime<Utc>>);
}