Struct Repo 

pub struct Repo { /* private fields */ }

The representation of a repo on the hub.

Implementations

impl Repo

pub fn new(repo_id: &str, repo_type: RepoType) -> Self

Creates a new Repo instance with the specified repo_id and repo_type.

pub fn set_revision(&mut self, revision: &str)

Sets the revision of the repository.

pub fn set_cache_dir(&mut self, cache_dir: impl Into<PathBuf>)

Sets the cache directory for the repository.

pub fn new_model(repo_id: &str) -> Self

Shortcut for creating a new model repository.

Examples found in repository

examples/pull.rs (line 5)

fn main() {
    let cat = ModelsCat::new(Repo::new_model("BAAI/bge-small-zh-v1.5"));
    cat.download_with_progress("model.safetensors", ProgressBarWrapper::default())
        .unwrap();
}

pub fn new_dataset(repo_id: &str) -> Self

Shortcut for creating a new dataset repository.

pub fn new_space(repo_id: &str) -> Self

Shortcut for creating a new space repository.

pub fn cache_home(&self) -> &PathBuf

Get the cache home directory.

pub fn repo_id(&self) -> &str

Get the repository ID.

pub fn repo_type(&self) -> &RepoType

Get the repository type.

pub fn revision(&self) -> &str

Get the revision.

pub fn cache_dir(&self) -> PathBuf

Constructs and returns the full cache directory path for the repository.

This function generates a unique cache directory path based on the repository type and ID. The path is constructed to ensure compatibility with filesystem path conventions.

pub fn url_path(&self) -> String

Get the URL path for this repo

pub fn url_path_with_revision(&self) -> String

Get the URL path for this repo with revision

pub fn url_path_with_resolve(&self) -> String

Get the URL path for this repo with resolve

pub fn safe_revision_path(&self) -> String

Revision needs to be url escaped before being used in a URL

pub fn ref_path(&self) -> PathBuf

Get ref path, such as

pub fn create_ref(&self, commit_hash: &str) -> Result<(), Error>

Creates a reference in the cache directory that points branches to the correct commits within the blobs.

pub fn snapshot_path(&self, commit_hash: &str) -> PathBuf

Returns the path to the snapshot directory for a specific commit hash.

The snapshot directory is located within the repository’s cache directory under the snapshots folder. This function constructs the full path by appending the snapshots folder and the provided commit_hash.

Trait Implementations

impl Clone for Repo

fn clone(&self) -> Repo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Repo

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

Formats the value using the given formatter.