confex-core 0.1.0

Core engine for confex - source merging, hot-reload, migrations, and encryption
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! Cross-platform application directory lookup.
//!
//! Two modes:
//!
//! - **Default** (no features): confex derives XDG / `%APPDATA%` / `~/Library`
//!   paths itself. Desktop only (Linux, macOS, Windows).
//! - **`istmo` feature**: delegates to [`istmo_core::path`], which also covers
//!   Android (`Context.filesDir`) and iOS (`NSFileManager`). The per-app
//!   subdirectory is derived from the build-time `ISTMO_APP_BUNDLE_ID` env
//!   var (baked by `istmo-build::emit_app`), so the `app_name` argument of
//!   [`app_config_dir`] / [`app_data_dir`] is **ignored** in this mode —
//!   istmo already resolved the app identity.

use std::path::PathBuf;

/// Returns the base directory for user configuration files.
///
/// - **With `istmo` feature**: [`istmo_core::path::config_dir`] (already
///   includes the app's bundle id subdir).
/// - Linux/BSD: `$XDG_CONFIG_HOME` or `~/.config`
/// - macOS: `~/Library/Application Support`
/// - Windows: `%APPDATA%`
#[cfg(feature = "istmo")]
#[must_use]
pub fn config_base_dir() -> Option<PathBuf> {
    Some(istmo_core::path::config_dir().to_path_buf())
}

#[cfg(all(not(feature = "istmo"), target_os = "windows"))]
#[must_use]
pub fn config_base_dir() -> Option<PathBuf> {
    std::env::var_os("APPDATA").map(PathBuf::from)
}

#[cfg(all(not(feature = "istmo"), target_os = "macos"))]
#[must_use]
pub fn config_base_dir() -> Option<PathBuf> {
    home_dir().map(|h| h.join("Library").join("Application Support"))
}

#[cfg(all(
    not(feature = "istmo"),
    not(any(target_os = "windows", target_os = "macos"))
))]
#[must_use]
pub fn config_base_dir() -> Option<PathBuf> {
    std::env::var_os("XDG_CONFIG_HOME")
        .map(PathBuf::from)
        .or_else(|| home_dir().map(|h| h.join(".config")))
}

/// Returns the base directory for application data files.
///
/// - **With `istmo` feature**: [`istmo_core::path::data_dir`] (already
///   includes the app's bundle id subdir).
/// - Linux/BSD: `$XDG_DATA_HOME` or `~/.local/share`
/// - macOS: `~/Library/Application Support`
/// - Windows: `%LOCALAPPDATA%`
#[cfg(feature = "istmo")]
#[must_use]
pub fn data_base_dir() -> Option<PathBuf> {
    Some(istmo_core::path::data_dir().to_path_buf())
}

#[cfg(all(not(feature = "istmo"), target_os = "windows"))]
#[must_use]
pub fn data_base_dir() -> Option<PathBuf> {
    std::env::var_os("LOCALAPPDATA").map(PathBuf::from)
}

#[cfg(all(not(feature = "istmo"), target_os = "macos"))]
#[must_use]
pub fn data_base_dir() -> Option<PathBuf> {
    home_dir().map(|h| h.join("Library").join("Application Support"))
}

#[cfg(all(
    not(feature = "istmo"),
    not(any(target_os = "windows", target_os = "macos"))
))]
#[must_use]
pub fn data_base_dir() -> Option<PathBuf> {
    std::env::var_os("XDG_DATA_HOME")
        .map(PathBuf::from)
        .or_else(|| home_dir().map(|h| h.join(".local").join("share")))
}

/// Returns the config directory for a specific application.
///
/// With the `istmo` feature on, `_app_name` is ignored — istmo resolved the
/// app identity at build time via `ISTMO_APP_BUNDLE_ID`.
#[cfg(feature = "istmo")]
#[must_use]
pub fn app_config_dir(_app_name: &str) -> Option<PathBuf> {
    Some(istmo_core::path::config_dir().to_path_buf())
}

#[cfg(not(feature = "istmo"))]
#[must_use]
pub fn app_config_dir(app_name: &str) -> Option<PathBuf> {
    config_base_dir().map(|d| d.join(app_name))
}

/// Returns the data directory for a specific application.
///
/// With the `istmo` feature on, `_app_name` is ignored — istmo resolved the
/// app identity at build time via `ISTMO_APP_BUNDLE_ID`.
#[cfg(feature = "istmo")]
#[must_use]
pub fn app_data_dir(_app_name: &str) -> Option<PathBuf> {
    Some(istmo_core::path::data_dir().to_path_buf())
}

#[cfg(not(feature = "istmo"))]
#[must_use]
pub fn app_data_dir(app_name: &str) -> Option<PathBuf> {
    data_base_dir().map(|d| d.join(app_name))
}

/// Returns the OS-managed cache directory for a specific application.
///
/// Only available with the `istmo` feature (desktop + mobile unified).
#[cfg(feature = "istmo")]
#[must_use]
pub fn app_cache_dir(_app_name: &str) -> Option<PathBuf> {
    Some(istmo_core::path::cache_dir().to_path_buf())
}

/// Returns the state directory for a specific application.
///
/// Only available with the `istmo` feature (desktop + mobile unified).
#[cfg(feature = "istmo")]
#[must_use]
pub fn app_state_dir(_app_name: &str) -> Option<PathBuf> {
    Some(istmo_core::path::state_dir().to_path_buf())
}

#[cfg(not(feature = "istmo"))]
fn home_dir() -> Option<PathBuf> {
    std::env::var_os("HOME").map(PathBuf::from)
}