rcman 0.1.9

Framework-agnostic settings management with schema, backup/restore, secrets and derive macro support
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

use crate::error::Result;
use serde_json::Value;

/// Storage abstraction for sub-settings
pub trait SubSettingsStore: Send + Sync {
    /// Get an entry by key
    fn get(&self, key: &str) -> Result<Value>;

    /// Set an entry
    fn set(&self, key: &str, value: Value) -> Result<()>;

    /// Remove an entry
    fn remove(&self, key: &str) -> Result<()>;

    /// List all keys
    fn list(&self) -> Result<Vec<String>>;

    /// Get all entries
    fn get_all(&self) -> Result<std::collections::HashMap<String, Value>>;

    /// Invalidate any internal cache
    fn invalidate_cache(&self);

    /// Get the base path (directory) of the store
    fn get_base_path(&self) -> std::path::PathBuf;

    /// Get the single file path if applicable (returns None for `MultiFile`)
    fn get_single_file_path(&self) -> Option<std::path::PathBuf>;
}