Struct DatasetCache 

pub struct DatasetCache { /* private fields */ }

Manages caching of downloaded datasets, using both file-based and in-memory caching

This implementation uses scirs2-core::cache’s TTLSizedCache for in-memory caching, while maintaining the file-based persistence for long-term storage.

Implementations

impl DatasetCache

pub fn new(cachedir: PathBuf) -> Self

Create a new dataset cache with the given cache directory and default memory cache

pub fn with_config( cachedir: PathBuf, cache_size: usize, ttl_seconds: u64, ) -> Self

Create a new dataset cache with custom settings

pub fn with_full_config( cachedir: PathBuf, cache_size: usize, ttl_seconds: u64, max_cache_size: u64, offline_mode: bool, ) -> Self

Create a new dataset cache with comprehensive configuration

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

Create the cache directory if it doesn’t exist

pub fn get_cachedpath(&self, name: &str) -> PathBuf

Get the path to a cached file

pub fn is_cached(&self, name: &str) -> bool

Check if a file is already cached (either in memory or on disk)

pub fn read_cached(&self, name: &str) -> Result<Vec<u8>>

Read a cached file as bytes

This method checks the in-memory cache first, and falls back to the file system if needed. When reading from the file system, the result is also stored in the in-memory cache.

pub fn write_cached(&self, name: &str, data: &[u8]) -> Result<()>

Write data to both the file cache and memory cache

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

Clear the entire cache (both memory and file-based)

pub fn remove_cached(&self, name: &str) -> Result<()>

Remove a specific cached file (from both memory and file system)

pub fn hash_filename(name: &str) -> String

Compute a hash for a filename or URL

pub fn get_cache_size_bytes(&self) -> Result<u64>

Get the total size of the cache in bytes

pub fn set_offline_mode(&mut self, offline: bool)

Set offline mode

pub fn is_offline(&self) -> bool

Check if cache is in offline mode

pub fn set_max_cache_size(&mut self, max_size: u64)

Set maximum cache size in bytes (0 for unlimited)

pub fn max_cache_size(&self) -> u64

Get maximum cache size in bytes

pub fn put(&self, name: &str, data: &[u8]) -> Result<()>

Put data into the cache (alias for write_cached)

pub fn get_detailed_stats(&self) -> Result<DetailedCacheStats>

Get detailed cache information

Trait Implementations

impl Default for DatasetCache

fn default() -> Self

Returns the “default value” for a type.