Struct HFClientBuilder 

pub struct HFClientBuilder { /* private fields */ }

Builder for HFClient.

Get one via HFClient::builder() or HFClientBuilder::new(). Call build() when all options are set.

Implementations

impl HFClientBuilder

pub fn new() -> Self

Creates a builder with all options unset; defaults are applied at build time.

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

Overrides the Hub base URL (default: https://huggingface.co, or HF_ENDPOINT env var).

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

Sets the authentication token. Without this, the client falls back to the HF_TOKEN env var and the cached token file written by huggingface-cli login.

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

Overrides the User-Agent header sent with every request.

pub fn headers(self, headers: HeaderMap) -> Self

Merges additional default headers into every request. Ignored when a custom client is supplied (configure headers on that client directly).

pub fn client(self, client: Client) -> Self

Supplies a pre-configured reqwest::Client. Retry middleware is still applied on top. The caller is responsible for any default headers (including User-Agent) on this client; the headers and user_agent options are ignored.

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

Sets the local cache directory. Defaults to HF_HUB_CACHE → $HF_HOME/hub → ~/.cache/huggingface/hub.

pub fn cache_enabled(self, enabled: bool) -> Self

Enables or disables the local file cache. Caching is on by default.

pub fn retry_max_attempts(self, n: usize) -> Self

Overrides the maximum number of retry attempts after an initial failure (default: 3).

pub fn retry_base_delay(self, delay: Duration) -> Self

Overrides the base delay for exponential backoff between retries (default: 100ms).

pub fn build(self) -> HFResult<HFClient>

Builds the HFClient.

Errors

Returns an error if the endpoint URL is not a valid URL or if the reqwest client cannot be constructed (e.g., an invalid User-Agent string was provided).

pub fn build_sync(self) -> HFResult<HFClientSync>

Available on crate feature blocking only.

Builds the crate::blocking::HFClientSync.

Requires the blocking feature and is equivalent to calling build and then HFClientSync::from_inner.

Errors

Returns an error if the endpoint URL is not a valid URL, if the reqwest client cannot be constructed (e.g., an invalid User-Agent string was provided), or if the tokio runtime handle could not be correctly created for the blocking client.

Trait Implementations

impl Default for HFClientBuilder

fn default() -> Self

Returns the “default value” for a type.