Struct CacheManager 

pub struct CacheManager { /* private fields */ }

Manages cache directory and cache file operations

Implementations

impl CacheManager

pub fn with_dir(cache_dir: PathBuf) -> Self

Create a CacheManager rooted at an explicit directory (primarily for testing).

pub fn new(app_name: &str) -> Result<Self>

Create a CacheManager for app_name. DATUI_CACHE_DIR overrides the location; the test suite sets it so opens never record fixtures in the developer’s recents.

pub fn cache_dir(&self) -> &Path

Get the cache directory path

pub fn cache_file(&self, filename: &str) -> PathBuf

Get path to a specific cache file

pub fn ensure_cache_dir(&self) -> Result<()>

Ensure the cache directory exists

pub fn clear_all(&self) -> Result<()>

Remove every cache kind’s directory and line-file list (recents, histories, hidden sources, remembered places). Not lock files (another instance may hold them), the log, Data Quality copies (owned by their sessions), or views (config).

pub fn load_history_file(&self, history_id: &str) -> Result<Vec<String>>

Load a history file. An unreadable file is an error, never an empty list (the next push would write it back and lose every entry); a non-UTF-8 line is skipped alone.

pub fn update_history_file<F>( &self, history_id: &str, update: F, ) -> Result<HistoryUpdate>

where F: FnOnce(&mut Vec<String>),

Apply update to a history file with the read-modify-write under an exclusive lock: atomic writes prevent corruption but not lost updates from instances opening datasets at once. The lock is awaited up to LOCK_TIMEOUT, far past realistic contention, then the update is dropped: history never delays what the user asked for.

pub fn save_history_file( &self, history_id: &str, history: &[String], ) -> Result<()>

Save history to a history file

impl CacheManager

pub fn load_recents(&self) -> Vec<PathBuf>

Recently opened dataset paths, most recent first: the only thing datui remembers about your data between runs, and deleting it loses only ordering.

pub fn load_recents_with_visits( &self, ) -> (Vec<PathBuf>, HashMap<PathBuf, Visits>)

Recents, most recent first, with each one’s visits, in one read.

pub fn load_folds(&self) -> HashMap<String, bool>

Home sections the user folded (title<TAB>1) or opened (title<TAB>0), by title; unlisted sections take their default.

pub fn save_folds(&self, folds: &HashMap<String, bool>)

Remember the fold state. Failing to write it loses nothing but a preference.

pub fn terminal_mode(&self, terminal: &str) -> Option<ThemeMode>

The background mode terminal last reported, for the next start’s first frame under theme.mode = "auto". One line per terminal: key<TAB>dark.

pub fn remember_terminal_mode(&self, terminal: &str, mode: ThemeMode)

Remember what terminal answered, when it differs from what is remembered.

pub fn forget_recent(&self, path: &Path)

Forget one recent path: an editable recents list is one people trust.

pub fn forget_recents(&self, paths: &[PathBuf])

Forget several recently opened paths at once: every recent under one place.

pub fn clear_recents(&self)

Forget every recently opened path, leaving other caches alone.

pub fn push_recent(&self, path: &Path) -> HistoryUpdate

Record a path as most recently opened, deduplicated and capped. Failures are ignored: a convenience list must never hinder opening data. The result tells a write from a contended skip.

impl CacheManager

pub fn dataset_shape( &self, path: &str, fingerprint: &str, ) -> Option<DatasetShape>

The remembered shape of a dataset if fingerprint still matches (a mismatched entry has no correct use). A hit counts as use, so unchanging datasets stay.

pub fn has_dataset_shape(&self, path: &str) -> bool

Whether any shape is kept for path: one stat.

pub fn save_dataset_shape(&self, path: &str, shape: DatasetShape)

Remember one dataset’s shape, keeping the others while they fit the budget.

pub fn file_footers(&self, path: &str) -> Option<FileFooters>

The footers counts of the dataset at path have read, by file.

pub fn save_file_footers(&self, path: &str, footers: &FileFooters)

Remember the footers a count of the dataset at path read, by file.

pub fn cloud_listing(&self, id: &str, fingerprint: &str) -> Option<CloudListing>

The last listing of cloud source id, if it was taken at fingerprint.

pub fn save_cloud_listing(&self, id: &str, listing: CloudListing)

Record one source’s listing, keeping the others.

pub fn load_hidden_cloud_sources(&self) -> Vec<String>

Source IDs hidden from the home screen with Delete.

pub fn hide_cloud_source(&self, id: &str)

Hide a source from the home screen until the cache is cleared.

pub fn examples_hidden(&self) -> bool

Whether Delete on its heading hid the bundled Example datasets (a user’s examples.toml still shows).

pub fn hide_examples(&self)

Hide the bundled Example datasets until the cache is cleared.

pub fn load_remembered_places(&self) -> Vec<PathBuf>

The directories Ctrl+D kept here before 0.4.0 (now in catalog.toml), in added order.

pub fn clear_remembered_places(&self)

Drop the list Self::load_remembered_places reads, once it is moved.

pub fn save_remembered_places(&self, places: &[PathBuf]) -> Result<()>

Write places where Ctrl+D kept them before 0.4.0, for the migration’s tests.

impl CacheManager

pub fn load_dataset_facts(&self) -> HashMap<PathBuf, DatasetFacts>

Every remembered dataset fact, not counted as use. Unreadable records are absent: failing to read a cache must never be worse than lacking it.

pub fn dataset_facts(&self, path: &Path) -> Option<DatasetFacts>

What datui knows about one dataset, counted as use.

pub fn touch_dataset_facts<'a>(&self, paths: impl IntoIterator<Item = &'a Path>)

Count these records as used (shown on home); least recently used go first past the budget.

pub fn record_dataset_facts(&self, facts: &[(PathBuf, DatasetFacts)])

Record newly measured datasets, one file each; non-UTF-8 paths are skipped.

Trait Implementations

impl Clone for CacheManager

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CacheManager

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.