opendal_core/services/ipmfs/
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 serde::Deserialize;
19use serde::Serialize;
20
21use super::builder::IpmfsBuilder;
22
23/// Config for IPFS MFS support.
24#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
25#[serde(default)]
26#[non_exhaustive]
27pub struct IpmfsConfig {
28    /// Root for ipfs.
29    pub root: Option<String>,
30    /// Endpoint for ipfs.
31    pub endpoint: Option<String>,
32}
33
34impl crate::Configurator for IpmfsConfig {
35    type Builder = IpmfsBuilder;
36
37    fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
38        let mut map = uri.options().clone();
39        if let Some(authority) = uri.authority() {
40            map.insert("endpoint".to_string(), format!("http://{authority}"));
41        }
42
43        if let Some(root) = uri.root() {
44            if !root.is_empty() {
45                map.insert("root".to_string(), root.to_string());
46            }
47        }
48
49        Self::from_iter(map)
50    }
51
52    #[allow(deprecated)]
53    fn into_builder(self) -> Self::Builder {
54        IpmfsBuilder {
55            config: self,
56            http_client: None,
57        }
58    }
59}
60
61#[cfg(test)]
62mod tests {
63    use super::*;
64    use crate::Configurator;
65    use crate::types::OperatorUri;
66
67    #[test]
68    fn from_uri_sets_endpoint_and_root() {
69        let uri = OperatorUri::new(
70            "ipmfs://localhost:5001/mfs/path",
71            Vec::<(String, String)>::new(),
72        )
73        .unwrap();
74
75        let cfg = IpmfsConfig::from_uri(&uri).unwrap();
76        assert_eq!(cfg.endpoint.as_deref(), Some("http://localhost:5001"));
77        assert_eq!(cfg.root.as_deref(), Some("mfs/path"));
78    }
79}