citum_store 0.83.0

Citum style and locale storage layer — registry, cache, and resolver chain
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

/*
SPDX-License-Identifier: MIT OR Apache-2.0
SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus and Citum contributors
*/

//! Platform-aware store for user-installed Citum styles and locales.
//!
//! Provides a `StoreResolver` that searches user data directories for custom styles
//! and locales, with fallback to embedded builtins. Supports YAML, JSON, and CBOR formats.

#![allow(missing_docs, reason = "lib/crate")]

#[cfg(feature = "http")]
pub mod chain;
#[cfg(feature = "http")]
pub mod cid;
pub mod config;
pub mod format;
pub mod paths;
pub mod resolver;

#[cfg(test)]
#[allow(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::panic,
    clippy::indexing_slicing,
    clippy::todo,
    clippy::unimplemented,
    clippy::unreachable,
    clippy::get_unwrap,
    reason = "Panicking is acceptable and often desired in tests."
)]
mod resolver_tests;

#[cfg(feature = "http")]
pub use chain::{build_chain_with_file_locale_dir, build_standard_chain, load_locale_or_default};
pub use config::StoreConfig;
pub use format::StoreFormat;
#[cfg(feature = "http")]
pub use resolver::ChainResolver;
#[cfg(feature = "http")]
pub use resolver::{
    CidResolver, DEFAULT_CID_GATEWAY, GitResolver, HttpResolver, RemoteFetchPolicy,
    VerifyingResolver, fetch_and_verify_bytes,
};
pub use resolver::{
    EmbeddedResolver, FileLocaleResolver, FileResolver, RegistryResolver, ResolverError,
    StoreResolver,
};

use std::path::PathBuf;

/// Returns the platform-specific data directory for Citum user files.
///
/// This path is derived from [`paths::data_dir()`] with a `citum` subdirectory appended.
///
/// Typical locations:
/// - Unix (incl. macOS): `~/.local/share/citum/`
/// - Windows: `%APPDATA%\citum\`
#[must_use]
pub fn platform_data_dir() -> Option<PathBuf> {
    paths::data_dir().map(|d| d.join("citum"))
}

/// Returns the platform-specific configuration directory for Citum.
///
/// This path is derived from [`paths::config_dir()`] with a `citum` subdirectory appended.
///
/// Typical locations:
/// - Unix (incl. macOS): `~/.config/citum/`
/// - Windows: `%APPDATA%\citum\`
#[must_use]
pub fn platform_config_dir() -> Option<PathBuf> {
    paths::config_dir().map(|d| d.join("citum"))
}

/// Returns the platform-specific cache directory for Citum.
///
/// This path is derived from [`paths::cache_dir()`] with a `citum` subdirectory appended.
///
/// Typical locations:
/// - Unix (incl. macOS): `~/.cache/citum/`
/// - Windows: `%LOCALAPPDATA%\citum\`
#[must_use]
pub fn platform_cache_dir() -> Option<PathBuf> {
    paths::cache_dir().map(|d| d.join("citum"))
}