Struct kitchen_fridge::cache::Cache

pub struct Cache { /* fields omitted */ }

A CalDAV source that stores its items in a local folder.

It automatically updates the content of the folder when dropped (see its Drop implementation), but you can also manually call Cache::save_to_folder

Most of its methods are part of the CalDavSource trait implementation

Implementations

impl Cache

pub fn cache_folder() -> PathBuf

Get the path to the cache folder

pub fn from_folder(folder: &Path) -> Result<Self, Box<dyn Error>>

Initialize a cache from the content of a valid backing folder if it exists. Returns an error otherwise

pub fn new(folder_path: &Path) -> Self

Initialize a cache with the default contents

pub fn save_to_folder(&self) -> Result<(), Error>

Store the current Cache to its backing folder

Note that this is automatically called when self is dropped

impl Cache

pub fn get_calendars_sync(
    &self
) -> Result<HashMap<Url, Arc<Mutex<CachedCalendar>>>, Box<dyn Error>>

The non-async version of crate::traits::CalDavSource::get_calendars

pub fn get_calendar_sync(&self, url: &Url) -> Option<Arc<Mutex<CachedCalendar>>>

The non-async version of crate::traits::CalDavSource::get_calendar

Trait Implementations

impl CalDavSource<CachedCalendar> for Cache

fn get_calendars<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<HashMap<Url, Arc<Mutex<CachedCalendar>>>, Box<dyn Error>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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)

fn get_calendar<'life0, 'life1, 'async_trait>(
    &'life0 self,
    url: &'life1 Url
) -> Pin<Box<dyn Future<Output = Option<Arc<Mutex<CachedCalendar>>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Returns the calendar matching the URL

fn create_calendar<'life0, 'async_trait>(
    &'life0 mut self,
    url: Url,
    name: String,
    supported_components: SupportedComponents,
    color: Option<Color>
) -> Pin<Box<dyn Future<Output = Result<Arc<Mutex<CachedCalendar>>, Box<dyn Error>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Create a calendar if it did not exist, and return it

impl Debug for Cache

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

Formats the value using the given formatter.

impl Drop for Cache

fn drop(&mut self)

Executes the destructor for this type.