opendal_service_ipfs/
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 crate::backend::IpfsBuilder;
22
23/// Config for IPFS file system support.
24#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
25#[serde(default)]
26#[non_exhaustive]
27pub struct IpfsConfig {
28    /// IPFS gateway endpoint.
29    pub endpoint: Option<String>,
30    /// IPFS root.
31    pub root: Option<String>,
32}
33
34impl opendal_core::Configurator for IpfsConfig {
35    type Builder = IpfsBuilder;
36
37    fn from_uri(uri: &opendal_core::OperatorUri) -> opendal_core::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            && !root.is_empty()
45        {
46            map.insert("root".to_string(), root.to_string());
47        }
48
49        Self::from_iter(map)
50    }
51
52    fn into_builder(self) -> Self::Builder {
53        IpfsBuilder { config: self }
54    }
55}
56
57#[cfg(test)]
58mod tests {
59    use super::*;
60    use opendal_core::Configurator;
61    use opendal_core::OperatorUri;
62
63    #[test]
64    fn from_uri_sets_endpoint_and_root() {
65        let uri = OperatorUri::new(
66            "ipfs://ipfs.io/ipfs/QmHash/path",
67            Vec::<(String, String)>::new(),
68        )
69        .unwrap();
70
71        let cfg = IpfsConfig::from_uri(&uri).unwrap();
72        assert_eq!(cfg.endpoint.as_deref(), Some("http://ipfs.io"));
73        assert_eq!(cfg.root.as_deref(), Some("ipfs/QmHash/path"));
74    }
75
76    #[test]
77    fn from_uri_allows_missing_authority() {
78        let uri = OperatorUri::new("ipfs", Vec::<(String, String)>::new()).unwrap();
79
80        let cfg = IpfsConfig::from_uri(&uri).unwrap();
81        assert!(cfg.endpoint.is_none());
82    }
83}
opendal_service_ipfs/config.rs

opendal_service_ipfs/
config.rs
