Struct HfConfig 

#[non_exhaustive]
pub struct HfConfig {
    pub repo_type: Option<HfRepoType>,
    pub repo_id: Option<String>,
    pub revision: Option<String>,
    pub root: Option<String>,
    pub token: Option<String>,
    pub endpoint: Option<String>,
    pub download_mode: Option<HfDownloadMode>,
    pub enable_resolve_cache: bool,
}

Available on crate feature services-hf only.

Configuration for Hugging Face service support.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

repo_type: Option<HfRepoType>

Repo type of this backend. Required.

repo_id: Option<String>

Repo id of this backend.

This is required.

revision: Option<String>

Revision of this backend.

Default is main.

root: Option<String>

Root of this backend. Can be “/path/to/dir”.

Default is “/”.

token: Option<String>

Token of this backend.

This is optional.

endpoint: Option<String>

Endpoint of the Hugging Face Hub.

The default is https://huggingface.co.

download_mode: Option<HfDownloadMode>

Download mode. Either xet (default) or http.

When unset, the mode is resolved from the HF_HUB_DISABLE_XET environment variable: a non-empty value forces http, otherwise it defaults to xet. An explicit value here takes precedence.

See https://huggingface.co/docs/huggingface_hub/package_reference/environment_variables#hfhubdisablexet.

enable_resolve_cache: bool

Enable caching of resolved HTTP download addresses and XET file metadata.

Defaults to false. Set to true to share resolve results across readers on the same backend. Changed files may remain invisible while cached results are reused. A reader retains XET metadata from its first read for its lifetime. Create a new reader to resolve the path again when this option is disabled. See HfBuilder::enable_resolve_cache for freshness semantics.

Trait Implementations

impl Clone for HfConfig

fn clone(&self) -> HfConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurator for HfConfig

type Builder = HfBuilder

Associated builder for this configuration.

fn from_uri(uri: &OperatorUri) -> Result<HfConfig, Error>

Build configuration from a parsed URI with merged options.

fn into_builder(self) -> <HfConfig as Configurator>::Builder

Convert this configuration into a service builder.

fn from_iter( iter: impl IntoIterator<Item = (String, String)>, ) -> Result<Self, Error>

Deserialize from an iterator.

impl Debug for HfConfig

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

Formats the value using the given formatter.

impl Default for HfConfig

fn default() -> HfConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HfConfig

where HfConfig: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<HfConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HfConfig

fn eq(&self, other: &HfConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HfConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HfConfig

impl StructuralPartialEq for HfConfig