This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 92a33e70a refactor(services/ipfs): extract ipfs service into separate
crate (#6991)
92a33e70a is described below
commit 92a33e70ae341e46231343bbd315274ce2197d8c
Author: XYenon <[email protected]>
AuthorDate: Fri Dec 12 22:22:44 2025 +0800
refactor(services/ipfs): extract ipfs service into separate crate (#6991)
- Create new crate opendal-service-ipfs at core/services/ipfs/
- Move source files from core/core/src/services/ipfs/ to new crate
- Update imports from crate:: to opendal_core::
- Add optional dependency in core/Cargo.toml
- Update services-ipfs feature to use dep:opendal-service-ipfs
- Add facade re-export in core/src/lib.rs
- Remove services-ipfs feature from core/core/Cargo.toml
The public API (opendal::services::Ipfs, opendal::services::IpfsConfig)
and feature flag (services-ipfs) remain unchanged.
---
core/Cargo.lock | 15 ++++++++
core/Cargo.toml | 3 +-
core/core/Cargo.toml | 1 -
core/core/src/services/mod.rs | 5 ---
core/services/ipfs/Cargo.toml | 44 ++++++++++++++++++++++
.../services/ipfs => services/ipfs/src}/backend.rs | 14 +++----
.../services/ipfs => services/ipfs/src}/config.rs | 10 ++---
.../services/ipfs => services/ipfs/src}/core.rs | 6 +--
.../services/ipfs => services/ipfs/src}/docs.md | 5 +--
.../services/ipfs => services/ipfs/src}/error.rs | 4 +-
.../services/ipfs => services/ipfs/src}/ipld.rs | 0
.../ipfs/mod.rs => services/ipfs/src/lib.rs} | 12 +++---
core/src/lib.rs | 2 +
13 files changed, 89 insertions(+), 32 deletions(-)
diff --git a/core/Cargo.lock b/core/Cargo.lock
index 556ba6afe..39187404b 100644
--- a/core/Cargo.lock
+++ b/core/Cargo.lock
@@ -5504,6 +5504,7 @@ dependencies = [
"opendal-service-ftp",
"opendal-service-ghac",
"opendal-service-hdfs-native",
+ "opendal-service-ipfs",
"opendal-service-moka",
"opendal-service-mysql",
"opendal-service-obs",
@@ -5936,6 +5937,20 @@ dependencies = [
"serde",
]
+[[package]]
+name = "opendal-service-ipfs"
+version = "0.55.0"
+dependencies = [
+ "bytes",
+ "ctor",
+ "http 1.4.0",
+ "log",
+ "opendal-core",
+ "prost 0.13.5",
+ "serde",
+ "tokio",
+]
+
[[package]]
name = "opendal-service-moka"
version = "0.55.0"
diff --git a/core/Cargo.toml b/core/Cargo.toml
index f74d35fd8..924ea7fd3 100644
--- a/core/Cargo.toml
+++ b/core/Cargo.toml
@@ -127,7 +127,7 @@ services-hdfs = ["opendal-core/services-hdfs"]
services-hdfs-native = ["dep:opendal-service-hdfs-native"]
services-http = ["opendal-core/services-http"]
services-huggingface = ["opendal-core/services-huggingface"]
-services-ipfs = ["opendal-core/services-ipfs"]
+services-ipfs = ["dep:opendal-service-ipfs"]
services-ipmfs = ["opendal-core/services-ipmfs"]
services-koofr = ["opendal-core/services-koofr"]
services-lakefs = ["opendal-core/services-lakefs"]
@@ -209,6 +209,7 @@ opendal-service-cloudflare-kv = { path =
"services/cloudflare-kv", version = "0.
opendal-service-ghac = { path = "services/ghac", version = "0.55.0", optional
= true, default-features = false }
opendal-service-hdfs-native = { path = "services/hdfs-native", version =
"0.55.0", optional = true, default-features = false }
opendal-service-ftp = { path = "services/ftp", version = "0.55.0", optional =
true, default-features = false }
+opendal-service-ipfs = { path = "services/ipfs", version = "0.55.0", optional
= true, default-features = false }
opendal-service-moka = { path = "services/moka", version = "0.55.0", optional
= true, default-features = false }
opendal-service-mysql = { path = "services/mysql", version = "0.55.0",
optional = true, default-features = false }
opendal-service-obs = { path = "services/obs", version = "0.55.0", optional =
true, default-features = false }
diff --git a/core/core/Cargo.toml b/core/core/Cargo.toml
index 78ec36787..59193adaa 100644
--- a/core/core/Cargo.toml
+++ b/core/core/Cargo.toml
@@ -102,7 +102,6 @@ services-gridfs = ["dep:mongodb",
"dep:mongodb-internal-macros"]
services-hdfs = ["dep:hdrs"]
services-http = []
services-huggingface = []
-services-ipfs = ["dep:prost"]
services-ipmfs = []
services-koofr = []
services-lakefs = []
diff --git a/core/core/src/services/mod.rs b/core/core/src/services/mod.rs
index f8dfc907e..e293df73e 100644
--- a/core/core/src/services/mod.rs
+++ b/core/core/src/services/mod.rs
@@ -114,11 +114,6 @@ mod huggingface;
#[cfg(feature = "services-huggingface")]
pub use huggingface::*;
-#[cfg(feature = "services-ipfs")]
-mod ipfs;
-#[cfg(feature = "services-ipfs")]
-pub use self::ipfs::*;
-
#[cfg(feature = "services-ipmfs")]
mod ipmfs;
#[cfg(feature = "services-ipmfs")]
diff --git a/core/services/ipfs/Cargo.toml b/core/services/ipfs/Cargo.toml
new file mode 100644
index 000000000..107665f8f
--- /dev/null
+++ b/core/services/ipfs/Cargo.toml
@@ -0,0 +1,44 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[package]
+description = "Apache OpenDAL IPFS service implementation"
+name = "opendal-service-ipfs"
+
+authors = { workspace = true }
+edition = { workspace = true }
+homepage = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+rust-version = { workspace = true }
+version = { workspace = true }
+
+[package.metadata.docs.rs]
+all-features = true
+
+[dependencies]
+opendal-core = { path = "../../core", version = "0.55.0", default-features =
false }
+
+bytes = { workspace = true }
+ctor = { workspace = true }
+http = { workspace = true }
+log = { workspace = true }
+prost = "0.13"
+serde = { workspace = true, features = ["derive"] }
+
+[dev-dependencies]
+tokio = { workspace = true, features = ["macros", "rt-multi-thread"] }
diff --git a/core/core/src/services/ipfs/backend.rs
b/core/services/ipfs/src/backend.rs
similarity index 97%
rename from core/core/src/services/ipfs/backend.rs
rename to core/services/ipfs/src/backend.rs
index f7d78389a..bb7a4fc47 100644
--- a/core/core/src/services/ipfs/backend.rs
+++ b/core/services/ipfs/src/backend.rs
@@ -23,13 +23,13 @@ use http::StatusCode;
use log::debug;
use prost::Message;
-use super::IPFS_SCHEME;
-use super::config::IpfsConfig;
-use super::core::IpfsCore;
-use super::error::parse_error;
-use super::ipld::PBNode;
-use crate::raw::*;
-use crate::*;
+use crate::IPFS_SCHEME;
+use crate::config::IpfsConfig;
+use crate::core::IpfsCore;
+use crate::error::parse_error;
+use crate::ipld::PBNode;
+use opendal_core::raw::*;
+use opendal_core::*;
/// IPFS file system support based on [IPFS HTTP
Gateway](https://docs.ipfs.tech/concepts/ipfs-gateway/).
#[doc = include_str!("docs.md")]
diff --git a/core/core/src/services/ipfs/config.rs
b/core/services/ipfs/src/config.rs
similarity index 90%
rename from core/core/src/services/ipfs/config.rs
rename to core/services/ipfs/src/config.rs
index 8300cf9ae..b80eba282 100644
--- a/core/core/src/services/ipfs/config.rs
+++ b/core/services/ipfs/src/config.rs
@@ -18,7 +18,7 @@
use serde::Deserialize;
use serde::Serialize;
-use super::backend::IpfsBuilder;
+use crate::backend::IpfsBuilder;
/// Config for IPFS file system support.
#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -31,10 +31,10 @@ pub struct IpfsConfig {
pub root: Option<String>,
}
-impl crate::Configurator for IpfsConfig {
+impl opendal_core::Configurator for IpfsConfig {
type Builder = IpfsBuilder;
- fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
+ fn from_uri(uri: &opendal_core::OperatorUri) -> opendal_core::Result<Self>
{
let mut map = uri.options().clone();
if let Some(authority) = uri.authority() {
map.insert("endpoint".to_string(), format!("http://{authority}";));
@@ -57,8 +57,8 @@ impl crate::Configurator for IpfsConfig {
#[cfg(test)]
mod tests {
use super::*;
- use crate::Configurator;
- use crate::types::OperatorUri;
+ use opendal_core::Configurator;
+ use opendal_core::OperatorUri;
#[test]
fn from_uri_sets_endpoint_and_root() {
diff --git a/core/core/src/services/ipfs/core.rs
b/core/services/ipfs/src/core.rs
similarity index 99%
rename from core/core/src/services/ipfs/core.rs
rename to core/services/ipfs/src/core.rs
index 681ffceeb..82f7016ed 100644
--- a/core/core/src/services/ipfs/core.rs
+++ b/core/services/ipfs/src/core.rs
@@ -22,9 +22,9 @@ use http::Request;
use http::Response;
use http::StatusCode;
-use super::error::parse_error;
-use crate::raw::*;
-use crate::*;
+use crate::error::parse_error;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct IpfsCore {
pub info: Arc<AccessorInfo>,
diff --git a/core/core/src/services/ipfs/docs.md
b/core/services/ipfs/src/docs.md
similarity index 90%
rename from core/core/src/services/ipfs/docs.md
rename to core/services/ipfs/src/docs.md
index dd37bbf78..94671e951 100644
--- a/core/core/src/services/ipfs/docs.md
+++ b/core/services/ipfs/src/docs.md
@@ -24,9 +24,8 @@ You can refer to [`IpfsBuilder`]'s docs for more information
### Via Builder
```rust,no_run
-use anyhow::Result;
-use opendal_core::services::Ipfs;
-use opendal_core::Operator;
+use opendal::services::Ipfs;
+use opendal::Operator;
#[tokio::main]
async fn main() -> Result<()> {
diff --git a/core/core/src/services/ipfs/error.rs
b/core/services/ipfs/src/error.rs
similarity index 97%
rename from core/core/src/services/ipfs/error.rs
rename to core/services/ipfs/src/error.rs
index e47eda369..8fbd5eb99 100644
--- a/core/core/src/services/ipfs/error.rs
+++ b/core/services/ipfs/src/error.rs
@@ -18,8 +18,8 @@
use http::Response;
use http::StatusCode;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
/// Parse error response into Error.
pub(super) fn parse_error(resp: Response<Buffer>) -> Error {
diff --git a/core/core/src/services/ipfs/ipld.rs
b/core/services/ipfs/src/ipld.rs
similarity index 100%
rename from core/core/src/services/ipfs/ipld.rs
rename to core/services/ipfs/src/ipld.rs
diff --git a/core/core/src/services/ipfs/mod.rs b/core/services/ipfs/src/lib.rs
similarity index 84%
rename from core/core/src/services/ipfs/mod.rs
rename to core/services/ipfs/src/lib.rs
index 59e68e5f9..758545ae5 100644
--- a/core/core/src/services/ipfs/mod.rs
+++ b/core/services/ipfs/src/lib.rs
@@ -15,10 +15,9 @@
// specific language governing permissions and limitations
// under the License.
-/// Default scheme for ipfs service.
-pub const IPFS_SCHEME: &str = "ipfs";
-
-use crate::types::DEFAULT_OPERATOR_REGISTRY;
+#![cfg_attr(docsrs, feature(doc_cfg))]
+//! IPFS service implementation for Apache OpenDAL.
+#![deny(missing_docs)]
mod backend;
mod config;
@@ -29,7 +28,10 @@ mod ipld;
pub use backend::IpfsBuilder as Ipfs;
pub use config::IpfsConfig;
+/// Default scheme for ipfs service.
+pub const IPFS_SCHEME: &str = "ipfs";
+
#[ctor::ctor]
fn register_ipfs_service() {
- DEFAULT_OPERATOR_REGISTRY.register::<Ipfs>(IPFS_SCHEME);
+ opendal_core::DEFAULT_OPERATOR_REGISTRY.register::<Ipfs>(IPFS_SCHEME);
}
diff --git a/core/src/lib.rs b/core/src/lib.rs
index 9138ae3e5..c9e2b7b30 100644
--- a/core/src/lib.rs
+++ b/core/src/lib.rs
@@ -43,6 +43,8 @@ pub mod services {
pub use opendal_service_ghac::*;
#[cfg(feature = "services-hdfs-native")]
pub use opendal_service_hdfs_native::*;
+ #[cfg(feature = "services-ipfs")]
+ pub use opendal_service_ipfs::*;
#[cfg(feature = "services-moka")]
pub use opendal_service_moka::*;
#[cfg(feature = "services-mysql")]
