Struct ritecache::DiskCache

pub struct DiskCache<C, S: BuildHasher + Clone = DefaultHashBuilder> where
    C: Cache<OsString, u64, S, FileSize>,  { /* fields omitted */ }

An basic disk cache of files on disk.

Implementations

impl<C> DiskCache<C, DefaultHashBuilder> where
    C: Cache<OsString, u64, DefaultHashBuilder, FileSize>, 

pub fn new<T>(path: T, size: u64) -> Result<Self> where
    PathBuf: From<T>, 

Create an LruDiskCache that stores files in path, limited to size bytes.

Existing files in path will be stored with their last-modified time from the filesystem used as the order for the recency of their use. Any files that are individually larger than size bytes will be removed.

The cache is not observant of changes to files under path from external sources, it expects to have sole maintence of the contents.

impl<C, S> DiskCache<C, S> where
    C: Cache<OsString, u64, S, FileSize>,
    S: BuildHasher + Clone, 

pub fn new_with_hasher<T>(path: T, size: u64, hash_builder: S) -> Result<Self> where
    PathBuf: From<T>, 

Create an LruDiskCache that stores files in path, limited to size bytes.

Existing files in path will be stored with their last-modified time from the filesystem used as the order for the recency of their use. Any files that are individually larger than size bytes will be removed.

The cache is not observant of changes to files under path from external sources, it expects to have sole maintence of the contents.

pub fn size(&self) -> u64

Return the current size of all the files in the cache.

pub fn len(&self) -> usize

Return the count of entries in the cache.

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> u64

Return the maximum size of the cache.

pub fn path(&self) -> &Path

Return the path in which the cache is stored.

pub fn can_store(&self, size: u64) -> bool

Returns true if the disk cache can store a file of size bytes.

pub fn insert_with<K: AsRef<OsStr>, F: FnOnce(File) -> Result<()>>(
    &mut self,
    key: K,
    with: F
) -> Result<()>

Add a file by calling with with the open File corresponding to the cache at path key.

pub fn insert_bytes<K: AsRef<OsStr>>(
    &mut self,
    key: K,
    bytes: &[u8]
) -> Result<()>

Add a file with bytes as its contents to the cache at path key.

pub fn insert_file<K: AsRef<OsStr>, P: AsRef<OsStr>>(
    &mut self,
    key: K,
    path: P
) -> Result<()>

Add an existing file at path to the cache at path key.

pub fn contains_key<K: AsRef<OsStr>>(&self, key: K) -> bool

Return true if a file with path key is in the cache.

pub fn get_file<K: AsRef<OsStr>>(&mut self, key: K) -> Result<File>

Get an opened File for key, if one exists and can be opened. Updates the LRU state of the file if present. Avoid using this method if at all possible, prefer .get.

pub fn get<K: AsRef<OsStr>>(&mut self, key: K) -> Result<Box<dyn ReadSeek>>

Get an opened readable and seekable handle to the file at key, if one exists and can be opened. Updates the LRU state of the file if present.

pub fn remove<K: AsRef<OsStr>>(&mut self, key: K) -> Result<()>

Remove the given key from the cache.