Struct Cache

pub struct Cache { /* private fields */ }

A local struct used to fetch information from the cache folder.

Implementations

impl Cache

pub fn new(path: PathBuf) -> Self

Creates a new cache object location

pub fn from_env() -> Self

Creates cache from environment variable HF_HOME (if defined) otherwise defaults to [home_dir]/.cache/huggingface/

pub fn path(&self) -> &PathBuf

Creates a new cache object location

pub fn token_path(&self) -> PathBuf

Returns the location of the token file

pub fn token(&self) -> Option<String>

Returns the token value if it exists in the cache Use huggingface-cli login to set it up.

pub fn repo(&self, repo: Repo) -> CacheRepo

Creates a new handle CacheRepo which contains operations on a particular Repo

pub fn model(&self, model_id: String) -> CacheRepo

Simple wrapper over

let cache = Cache::new("/tmp/".into());
let cache = cache.repo(Repo::new(model_id, RepoType::Model));

pub fn dataset(&self, model_id: String) -> CacheRepo

Simple wrapper over

let cache = Cache::new("/tmp/".into());
let cache = cache.repo(Repo::new(model_id, RepoType::Dataset));

pub fn space(&self, model_id: String) -> CacheRepo

Simple wrapper over

let cache = Cache::new("/tmp/".into());
let cache = cache.repo(Repo::new(model_id, RepoType::Space));

Trait Implementations

impl Clone for Cache

fn clone(&self) -> Cache

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Cache

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Cache

fn default() -> Self

Returns the “default value” for a type.