Expand description
freqfs
is an in-memory cache layer over tokio::fs
with least-frequently-used eviction.
freqfs
automatically caches the most frequently-used files and backs up the others to disk.
This allows the developer to create and update large collections of data purely in-memory
without explicitly sync’ing to disk, while still retaining the flexibility to run on a host
with extremely limited memory. This is especially useful for web serving, database,
and data science applications.
See the examples directory for detailed usage examples.
This crate assumes that file paths are valid Unicode and may panic if it encounters a file path which is not valid Unicode.
It also assumes that all file I/O under the cache root directory
(the one whose path is passed to load
) is routed through the cache
(not e.g. via tokio::fs
or std::fs
elsewhere).
It may raise an std::io::Error
or panic if this assumption is not valid.
In the case that your program may not have permission to write to a filesystem entry, be sure to check the permissions before modifying it. The background cleanup thread will panic if it attempts an impermissible write operation.
Macros
- Implement
Name
for a type which implementsstd::str::FromStr
, to compare with a key type which dereferences to astr
.
Structs
- An in-memory cache layer over
tokio::fs
with least-frequently-used (LFU) eviction. - A filesystem directory
- A clone-able wrapper type over a
RwLock
on a directory. - A futures-aware read-write lock on a file
Enums
Traits
- A helper trait to coerce container types like
Arc
into a borrowed file. - Load a file-backed data structure.
- Write a file-backed data structure to the filesystem.
- A type that can be used to look up a directory entry without calling
to_string()
, to avoid unnecessary heap allocations.
Type Aliases
- A read lock on a directory.
- An owned read lock on a directory.
- A write lock on a directory.
- An owned write lock on a directory.
- A read guard on a file
- An owned read guard on a file
- A write guard on a file
- An owned write guard on a file