opendal_service_obs/
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;
19
20use serde::Deserialize;
21use serde::Serialize;
22
23use super::backend::ObsBuilder;
24
25/// Config for Huawei-Cloud Object Storage Service (OBS) support.
26#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
27#[serde(default)]
28#[non_exhaustive]
29pub struct ObsConfig {
30    /// Root for obs.
31    pub root: Option<String>,
32    /// Endpoint for obs.
33    pub endpoint: Option<String>,
34    /// Access key id for obs.
35    pub access_key_id: Option<String>,
36    /// Secret access key for obs.
37    pub secret_access_key: Option<String>,
38    /// Bucket for obs.
39    pub bucket: Option<String>,
40    /// Deprecated: OBS versioning capability is not controlled by service config.
41    #[deprecated(
42        since = "0.57.0",
43        note = "OBS versioning capability is not controlled by this option and this option is no longer needed."
44    )]
45    pub enable_versioning: bool,
46}
47
48impl Debug for ObsConfig {
49    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
50        f.debug_struct("ObsConfig")
51            .field("root", &self.root)
52            .field("endpoint", &self.endpoint)
53            .field("bucket", &self.bucket)
54            .finish_non_exhaustive()
55    }
56}
57
58impl opendal_core::Configurator for ObsConfig {
59    type Builder = ObsBuilder;
60
61    fn from_uri(uri: &opendal_core::OperatorUri) -> opendal_core::Result<Self> {
62        let mut map = uri.options().clone();
63
64        if let Some(name) = uri.name() {
65            map.insert("bucket".to_string(), name.to_string());
66        }
67
68        if let Some(root) = uri.root() {
69            map.insert("root".to_string(), root.to_string());
70        }
71
72        Self::from_iter(map)
73    }
74
75    fn into_builder(self) -> Self::Builder {
76        ObsBuilder { config: self }
77    }
78}
79
80#[cfg(test)]
81mod tests {
82    use super::*;
83    use opendal_core::Configurator;
84    use opendal_core::OperatorUri;
85
86    #[test]
87    fn from_uri_extracts_bucket_and_root() {
88        let uri = OperatorUri::new(
89            "obs://example-bucket/path/to/root",
90            Vec::<(String, String)>::new(),
91        )
92        .unwrap();
93        let cfg = ObsConfig::from_uri(&uri).unwrap();
94        assert_eq!(cfg.bucket.as_deref(), Some("example-bucket"));
95        assert_eq!(cfg.root.as_deref(), Some("path/to/root"));
96    }
97}
opendal_service_obs/config.rs

opendal_service_obs/
config.rs
