opendal/services/ipfs/
core.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;
20use std::sync::Arc;
21
22use http::Request;
23use http::Response;
24
25use crate::raw::*;
26use crate::*;
27
28pub struct IpfsCore {
29    pub info: Arc<AccessorInfo>,
30    pub endpoint: String,
31    pub root: String,
32}
33
34impl Debug for IpfsCore {
35    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
36        f.debug_struct("IpfsCore")
37            .field("endpoint", &self.endpoint)
38            .field("root", &self.root)
39            .finish()
40    }
41}
42
43impl IpfsCore {
44    pub async fn ipfs_get(&self, path: &str, range: BytesRange) -> Result<Response<HttpBody>> {
45        let p = build_rooted_abs_path(&self.root, path);
46
47        let url = format!("{}{}", self.endpoint, percent_encode_path(&p));
48
49        let mut req = Request::get(&url);
50
51        if !range.is_full() {
52            req = req.header(http::header::RANGE, range.to_header());
53        }
54
55        let req = req.body(Buffer::new()).map_err(new_request_build_error)?;
56
57        self.info.http_client().fetch(req).await
58    }
59
60    pub async fn ipfs_head(&self, path: &str) -> Result<Response<Buffer>> {
61        let p = build_rooted_abs_path(&self.root, path);
62
63        let url = format!("{}{}", self.endpoint, percent_encode_path(&p));
64
65        let req = Request::head(&url);
66
67        let req = req.body(Buffer::new()).map_err(new_request_build_error)?;
68
69        self.info.http_client().send(req).await
70    }
71
72    pub async fn ipfs_list(&self, path: &str) -> Result<Response<Buffer>> {
73        let p = build_rooted_abs_path(&self.root, path);
74
75        let url = format!("{}{}", self.endpoint, percent_encode_path(&p));
76
77        let mut req = Request::get(&url);
78
79        // Use "application/vnd.ipld.raw" to disable IPLD codec deserialization
80        // OpenDAL will parse ipld data directly.
81        //
82        // ref: https://github.com/ipfs/specs/blob/main/http-gateways/PATH_GATEWAY.md
83        req = req.header(http::header::ACCEPT, "application/vnd.ipld.raw");
84
85        let req = req.body(Buffer::new()).map_err(new_request_build_error)?;
86
87        self.info.http_client().send(req).await
88    }
89}
opendal/services/ipfs/core.rs

opendal/services/ipfs/
core.rs
