rust-cached-path

The idea behind cached-path is to provide a unified, simple interface for accessing both local and remote files. This can be used behind other APIs that need to access files agnostic to where they are located.

This is based on allennlp/common/file_utils.py and transformers/file_utils.py.

Installation

cached-path can be used as both a library and a command-line tool. To install cached-path as a command-line tool, run

bash cargo install --features build-binary cached-path

Usage

For remote resources, cached-path downloads and caches the resource, using the ETAG to know when to update the cache. The path returned is the local path to the latest cached version:

```rust use cachedpath::cachedpath;

let path = cachedpath("https://github.com/epwalsh/rust-cached-path/blob/master/README.md").unwrap(); assert!(path.isfile()); ```

```bash

From the command line:

$ cached-path https://github.com/epwalsh/rust-cached-path/blob/master/README.md /tmp/cache/055968a99316f3a42e7bcff61d3f590227dd7b03d17e09c41282def7c622ba0f.efa33e7f611ef2d163fea874ce614bb6fa5ab2a9d39d5047425e39ebe59fe782 ```

For local files, the path returned is just the original path supplied:

```rust use cachedpath::cachedpath;

let path = cachedpath("README.md").unwrap(); asserteq!(path.to_str().unwrap(), "README.md"); ```

```bash

From the command line:

$ cached-path https://github.com/epwalsh/rust-cached-path/blob/master/README.md README.md ```

It's easy to customize the cache location, the HTTP client, and other options using a CacheBuilder to construct a custom Cache object. This is also the recommend thing to do if your application makes multiple calls to cached_path, since it avoids the overhead of creating a new HTTP client on each call:

```rust use cached_path::Cache;

let cache = Cache::builder() .dir(std::env::tempdir().join("my-cache/")) .connecttimeout(std::time::Duration::fromsecs(3)) .build().unwrap(); let path = cache.cachedpath("README.md").unwrap(); ```

```bash

From the command line:

$ cached-path --dir /tmp/my-cache/ --connect-timeout 3 README.md README.md ```