ngdp-cache 0.4.3

Transparent caching layer with TTL support for all NGDP operations
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

//! Generic caching functionality for NGDP components
//!
//! This crate provides a flexible caching system for NGDP-related data including:
//! - Generic cache for arbitrary data
//! - CDN content cache (config, data, patch, indices)
//! - Ribbit response cache
//! - Cached clients for Ribbit, TACT, and CDN protocols

use std::path::{Path, PathBuf};

pub mod cached_cdn_client;
pub mod cached_ribbit_client;
pub mod cached_tact_client;
pub mod cdn;
pub mod error;
pub mod generic;
pub mod hybrid_version_client;
pub mod ribbit;
pub mod stats;

pub use cdn::CdnCache;
pub use error::{Error, Result};
pub use stats::{CacheReport, CacheStats, CacheStatsSnapshot};

/// Get the base NGDP cache directory
///
/// Returns a path like:
/// - Linux: `~/.cache/ngdp`
/// - macOS: `~/Library/Caches/ngdp`
/// - Windows: `C:\Users\{user}\AppData\Local\ngdp\cache`
pub fn get_cache_dir() -> Result<PathBuf> {
    dirs::cache_dir()
        .ok_or(Error::CacheDirectoryNotFound)
        .map(|dir| dir.join("ngdp"))
}

/// Ensure a directory exists, creating it if necessary
pub(crate) async fn ensure_dir(path: &Path) -> Result<()> {
    if tokio::fs::metadata(path).await.is_err() {
        tokio::fs::create_dir_all(path).await?;
    }
    Ok(())
}