vstorage 0.6.0

Common API for various icalendar/vcard storages.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

// Copyright 2025 Hugo Osvaldo Barrera
//
// SPDX-License-Identifier: EUPL-1.2

use futures_util::future::BoxFuture;
use std::time::Duration;
use tokio::time::Interval;

use crate::{
    Result,
    watch::{Event, StorageMonitor},
};

use super::VdirStorage;

/// Monitor for a [`VdirStorage`] instance.
///
/// # Quirks
///
/// This implementation does not use any in-kernel API, and simply polls every `interval`,
/// returning an [`Event::General`], which indicates that the entire storage must be re-scanned.
///
/// [general]: [crate::watch::Event::General]
pub struct VdirMonitor {
    timer: Interval,
}

impl VdirMonitor {
    /// Create a new monitor for `storage`.
    ///
    /// # Errors
    ///
    /// This portable implementation is infallible.
    pub fn new(_: &VdirStorage, interval: Duration) -> Result<VdirMonitor> {
        let mut timer = tokio::time::interval(interval);
        timer.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
        Ok(VdirMonitor { timer })
    }
}

impl StorageMonitor for VdirMonitor {
    fn next_event(&mut self) -> BoxFuture<'_, Event> {
        Box::pin(async {
            self.timer.tick().await;
            Event::General
        })
    }
}