Skip to main content

wordchipper_disk_cache/
lib.rs

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