Struct HuggingFaceModel 

pub struct HuggingFaceModel { /* private fields */ }

A synchronous Hugging Face model resolver.

Resolution is separate from crate::Engine::load. The resolver returns a standalone GGUF path or a sparse, runtime-complete Safetensors snapshot directory in the normal Hugging Face cache layout.

Implementations

impl HuggingFaceModel

pub fn gguf(repo_id: impl Into<String>, filename: impl Into<String>) -> Self

Selects one standalone GGUF file from the repository’s main revision.

pub fn safetensors(repo_id: impl Into<String>) -> Self

Selects a runtime-complete Safetensors directory from the repository’s main revision.

pub fn revision(self, revision: impl Into<String>) -> Self

Overrides the repository revision with a branch, tag, or commit.

pub fn cache_dir(self, cache_dir: impl Into<PathBuf>) -> Self

Overrides the Hugging Face Hub cache directory.

The path is the Hub cache itself (for example, ~/.cache/huggingface/hub), not its parent.

pub fn token(self, token: impl Into<String>) -> Self

Sets the Hugging Face token for this resolver.

An explicit token takes precedence over HF_TOKEN and the cached token.

pub fn progress(self, progress: bool) -> Self

Enables or disables download progress bars. Progress is disabled by default.

pub fn offline(self, offline: bool) -> Self

Enables or disables cache-only resolution. Offline mode never builds an API.

pub fn resolve(&self) -> Result<PathBuf, HuggingFaceError>

Resolves the selected model into the normal Hugging Face cache.

Trait Implementations

impl Clone for HuggingFaceModel

fn clone(&self) -> HuggingFaceModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HuggingFaceModel

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

Formats the value using the given formatter.