Struct PathCacher 

pub struct PathCacher<Q: PathQuery> { /* private fields */ }

Available on crate feature internal-path-cache only.

PathCacher is a cache for path query.

OpenDAL is designed for path based storage systems, such as S3, HDFS, etc. But there are many services that are not path based, such as OneDrive, Google Drive, etc. For these services, we look up files based on id. The lookup of id is very expensive, so we cache the path to id mapping in PathCacher.

Behavior

The path in the cache is always an absolute one. For example, if the service root is /root/, then the path of file a/b in cache will be /root/a/b.

Implementations

impl<Q: PathQuery> PathCacher<Q>

pub fn new(query: Q) -> Self

Create a new path cacher.

pub fn with_lock(self) -> Self

Enable the lock for the path cacher.

pub async fn insert(&self, path: &str, id: &str)

Insert a new cache entry.

pub async fn remove(&self, path: &str)

Remove a cache entry.

pub async fn get(&self, path: &str) -> Result<Option<String>>

Get the id for the given path.

pub async fn ensure_dir(&self, path: &str) -> Result<String>

Ensure input dir exists.