config_watcher 0.11.0

Config Watcher is a Rust library for tracking configuration items from files, Kubernetes ConfigMaps, and MQTT topics, providing real-time updates and structured data parsing.
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

mod config_file_watcher;
mod config_map_watcher;
mod config_mqtt_watcher;

pub use config_file_watcher::*;
pub use config_map_watcher::*;
pub use config_mqtt_watcher::*;
use tokio::sync::mpsc;

use crate::WatcherError;

#[derive(Debug)]
pub enum DocumentEvent {
    NewDocument(String, String), // New document (ID, Content) added with content
    ContentChanged(String, String), // Content of an existing document changed (ID, Content)
    DocumentRemoved(String),     // Document removed (ID)
}

pub struct WatcherHandle {
    pub(crate) command_sender: mpsc::Sender<WatcherCommand>, // Shutdown signal
    pub(crate) handle: Option<tokio::task::JoinHandle<Result<(), WatcherError>>>,
}

impl WatcherHandle {
    /// starts the watcher. Can only be used once!
    pub async fn start(&self) -> Result<(), WatcherError> {
        self.command_sender.send(WatcherCommand::Start).await?;
        Ok(())
    }

    /// Stops the watcher task.
    pub async fn stop(&mut self) -> Result<(), WatcherError> {
        self.command_sender.send(WatcherCommand::Stop).await?; // Send the shutdown signal
        if let Some(handle) = self.handle.take() {
            handle.await??;
        } else {
            log::warn!("Task handle was already taken or not initialized.");
        }

        Ok(())
    }
}

pub enum WatcherCommand {
    Start,
    Stop,
}