opendal/services/huggingface/
config.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::Debug;
19use std::fmt::Formatter;
20
21use serde::Deserialize;
22use serde::Serialize;
23
24/// Configuration for Huggingface service support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct HuggingfaceConfig {
29    /// Repo type of this backend. Default is model.
30    ///
31    /// Available values:
32    /// - model
33    /// - dataset
34    pub repo_type: Option<String>,
35    /// Repo id of this backend.
36    ///
37    /// This is required.
38    pub repo_id: Option<String>,
39    /// Revision of this backend.
40    ///
41    /// Default is main.
42    pub revision: Option<String>,
43    /// Root of this backend. Can be "/path/to/dir".
44    ///
45    /// Default is "/".
46    pub root: Option<String>,
47    /// Token of this backend.
48    ///
49    /// This is optional.
50    pub token: Option<String>,
51}
52
53impl Debug for HuggingfaceConfig {
54    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
55        let mut ds = f.debug_struct("HuggingfaceConfig");
56
57        if let Some(repo_type) = &self.repo_type {
58            ds.field("repo_type", &repo_type);
59        }
60        if let Some(repo_id) = &self.repo_id {
61            ds.field("repo_id", &repo_id);
62        }
63        if let Some(revision) = &self.revision {
64            ds.field("revision", &revision);
65        }
66        if let Some(root) = &self.root {
67            ds.field("root", &root);
68        }
69        if self.token.is_some() {
70            ds.field("token", &"<redacted>");
71        }
72
73        ds.finish()
74    }
75}
opendal/services/huggingface/config.rs

opendal/services/huggingface/
config.rs
