Skip to main content

wordchipper_disk_cache/
lib.rs

1//! # Wordchipper Disk Cache
2#![warn(missing_docs)]
3
4use crate::path_resolver::PathResolver;
5
6pub mod disk_cache;
7pub mod path_resolver;
8pub mod path_utils;
9
10#[doc(inline)]
11pub use disk_cache::{WordchipperDiskCache, WordchipperDiskCacheOptions};
12
13/// Environment variable key to override the default cache directory.
14pub const WORDCHIPPER_CACHE_DIR: &str = "WORDCHIPPER_CACHE_DIR";
15/// Environment variable key to override the default data directory.
16pub const WORDCHIPPER_DATA_DIR: &str = "WORDCHIPPER_DATA_DIR";
17
18/// Default [`PathResolver`] for wordchipper.
19pub const WORDCHIPPER_CACHE_CONFIG: PathResolver = PathResolver {
20    qualifier: "io.crates.wordchipper",
21    organization: "",
22    application: "wordchipper",
23    cache_env_vars: &[WORDCHIPPER_CACHE_DIR],
24    data_env_vars: &[WORDCHIPPER_DATA_DIR],
25};