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 1f554c1cd refactor(services/ftp): split service into its own crate
(#6979)
1f554c1cd is described below
commit 1f554c1cd7beb5e7df8500234c385eec5dc407c4
Author: x³u³ <[email protected]>
AuthorDate: Fri Dec 12 18:41:11 2025 +0800
refactor(services/ftp): split service into its own crate (#6979)
* refactor(services/ftp): split service into its own crate
Signed-off-by: xxxuuu <[email protected]>
* make cargo fmt happy
Signed-off-by: xxxuuu <[email protected]>
* remove unnecessary modifications
Signed-off-by: xxxuuu <[email protected]>
---------
Signed-off-by: xxxuuu <[email protected]>
---
core/Cargo.lock | 22 +++++++--
core/Cargo.toml | 3 +-
core/core/Cargo.toml | 14 ------
core/core/src/services/mod.rs | 5 --
core/services/ftp/Cargo.toml | 53 ++++++++++++++++++++++
.../services/ftp => services/ftp/src}/backend.rs | 10 ++--
.../services/ftp => services/ftp/src}/config.rs | 4 +-
.../src/services/ftp => services/ftp/src}/core.rs | 7 +--
.../services/ftp => services/ftp/src}/deleter.rs | 4 +-
.../src/services/ftp => services/ftp/src}/docs.md | 2 +-
.../src/services/ftp => services/ftp/src}/err.rs | 4 +-
.../ftp/mod.rs => services/ftp/src/lib.rs} | 2 +-
.../services/ftp => services/ftp/src}/lister.rs | 4 +-
.../services/ftp => services/ftp/src}/reader.rs | 4 +-
.../services/ftp => services/ftp/src}/writer.rs | 4 +-
core/src/lib.rs | 2 +
16 files changed, 99 insertions(+), 45 deletions(-)
diff --git a/core/Cargo.lock b/core/Cargo.lock
index 59d3fd5b3..5e7d058c8 100644
--- a/core/Cargo.lock
+++ b/core/Cargo.lock
@@ -5501,6 +5501,7 @@ dependencies = [
"opendal-service-azdls",
"opendal-service-azfile",
"opendal-service-cloudflare-kv",
+ "opendal-service-ftp",
"opendal-service-ghac",
"opendal-service-hdfs-native",
"opendal-service-moka",
@@ -5569,7 +5570,6 @@ dependencies = [
"flume",
"foundationdb",
"futures",
- "futures-rustls",
"getrandom 0.2.16",
"governor",
"hdfs-native",
@@ -5603,7 +5603,6 @@ dependencies = [
"reqsign",
"reqwest",
"rocksdb",
- "rustls-native-certs 0.8.2",
"serde",
"serde_json",
"sha1",
@@ -5611,7 +5610,6 @@ dependencies = [
"size",
"sled",
"sqlx",
- "suppaftp",
"surrealdb",
"tikv-client",
"tokio",
@@ -5891,6 +5889,24 @@ dependencies = [
"serde_json",
]
+[[package]]
+name = "opendal-service-ftp"
+version = "0.55.0"
+dependencies = [
+ "bytes",
+ "ctor",
+ "fastpool",
+ "futures",
+ "futures-rustls",
+ "http 1.4.0",
+ "log",
+ "opendal-core",
+ "rustls-native-certs 0.8.2",
+ "serde",
+ "suppaftp",
+ "tokio",
+]
+
[[package]]
name = "opendal-service-ghac"
version = "0.55.0"
diff --git a/core/Cargo.toml b/core/Cargo.toml
index 31a4b9fde..0450e8556 100644
--- a/core/Cargo.toml
+++ b/core/Cargo.toml
@@ -121,7 +121,7 @@ services-dropbox = ["opendal-core/services-dropbox"]
services-etcd = ["opendal-core/services-etcd"]
services-foundationdb = ["opendal-core/services-foundationdb"]
services-fs = ["opendal-core/services-fs"]
-services-ftp = ["opendal-core/services-ftp"]
+services-ftp = ["dep:opendal-service-ftp"]
services-gcs = ["opendal-core/services-gcs"]
services-gdrive = ["opendal-core/services-gdrive"]
services-ghac = ["dep:opendal-service-ghac"]
@@ -211,6 +211,7 @@ opendal-service-azfile = { path = "services/azfile",
version = "0.55.0", optiona
opendal-service-cloudflare-kv = { path = "services/cloudflare-kv", version =
"0.55.0", optional = true, default-features = false }
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-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 916d76519..b3ec4c05e 100644
--- a/core/core/Cargo.toml
+++ b/core/core/Cargo.toml
@@ -93,12 +93,6 @@ services-dropbox = []
services-etcd = ["dep:etcd-client", "dep:fastpool"]
services-foundationdb = ["dep:foundationdb"]
services-fs = ["tokio/fs", "internal-tokio-rt"]
-services-ftp = [
- "dep:suppaftp",
- "dep:fastpool",
- "dep:futures-rustls",
- "dep:rustls-native-certs",
-]
services-gcs = [
"dep:reqsign",
"reqsign?/services-google",
@@ -249,14 +243,6 @@ redis = { version = "1.0", features = [
rocksdb = { version = "0.21.0", default-features = false, optional = true }
# for services-sled
sled = { version = "0.34.7", optional = true }
-# for services-ftp
-futures-rustls = { version = "0.26.0", optional = true }
-rustls-native-certs = { version = "0.8", optional = true }
-suppaftp = { version = "6.3.0", default-features = false, features = [
- "async-secure",
- "rustls",
- "async-rustls",
-], optional = true }
# for services-tikv
tikv-client = { version = "0.3.0", optional = true, default-features = false }
# for services-hdfs-native
diff --git a/core/core/src/services/mod.rs b/core/core/src/services/mod.rs
index 766d4c99e..20fafb163 100644
--- a/core/core/src/services/mod.rs
+++ b/core/core/src/services/mod.rs
@@ -79,11 +79,6 @@ mod fs;
#[cfg(feature = "services-fs")]
pub use fs::*;
-#[cfg(feature = "services-ftp")]
-mod ftp;
-#[cfg(feature = "services-ftp")]
-pub use ftp::*;
-
#[cfg(feature = "services-gcs")]
mod gcs;
#[cfg(feature = "services-gcs")]
diff --git a/core/services/ftp/Cargo.toml b/core/services/ftp/Cargo.toml
new file mode 100644
index 000000000..5a690538d
--- /dev/null
+++ b/core/services/ftp/Cargo.toml
@@ -0,0 +1,53 @@
+# 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 FTP service implementation"
+name = "opendal-service-ftp"
+
+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 }
+fastpool = "1.0.2"
+futures = { workspace = true, default-features = false, features = [
+ "std",
+ "async-await",
+] }
+futures-rustls = "0.26.0"
+http = { workspace = true }
+log = { workspace = true }
+rustls-native-certs = "0.8"
+serde = { workspace = true, features = ["derive"] }
+suppaftp = { version = "6.3.0", default-features = false, features = [
+ "async-secure",
+ "rustls",
+ "async-rustls",
+] }
+tokio = { workspace = true, features = ["macros", "rt", "time"] }
diff --git a/core/core/src/services/ftp/backend.rs
b/core/services/ftp/src/backend.rs
similarity index 98%
rename from core/core/src/services/ftp/backend.rs
rename to core/services/ftp/src/backend.rs
index 555487717..048c6b220 100644
--- a/core/core/src/services/ftp/backend.rs
+++ b/core/services/ftp/src/backend.rs
@@ -21,7 +21,6 @@ use std::sync::Arc;
use http::Uri;
use log::debug;
-use services::ftp::core::Manager;
use suppaftp::FtpError;
use suppaftp::Status;
use suppaftp::list::File;
@@ -30,13 +29,14 @@ use suppaftp::types::Response;
use super::FTP_SCHEME;
use super::config::FtpConfig;
use super::core::FtpCore;
+use super::core::Manager;
use super::deleter::FtpDeleter;
use super::err::format_ftp_error;
use super::lister::FtpLister;
use super::reader::FtpReader;
use super::writer::FtpWriter;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
/// FTP and FTPS services support.
#[doc = include_str!("docs.md")]
@@ -335,8 +335,8 @@ impl FtpBackend {
#[cfg(test)]
mod build_test {
use super::FtpBuilder;
- use crate::services::FtpConfig;
- use crate::*;
+ use crate::FtpConfig;
+ use opendal_core::*;
#[test]
fn test_build() {
diff --git a/core/core/src/services/ftp/config.rs
b/core/services/ftp/src/config.rs
similarity index 94%
rename from core/core/src/services/ftp/config.rs
rename to core/services/ftp/src/config.rs
index f8624cba7..37a408269 100644
--- a/core/core/src/services/ftp/config.rs
+++ b/core/services/ftp/src/config.rs
@@ -47,10 +47,10 @@ impl Debug for FtpConfig {
}
}
-impl crate::Configurator for FtpConfig {
+impl opendal_core::Configurator for FtpConfig {
type Builder = FtpBuilder;
- 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(
diff --git a/core/core/src/services/ftp/core.rs b/core/services/ftp/src/core.rs
similarity index 98%
rename from core/core/src/services/ftp/core.rs
rename to core/services/ftp/src/core.rs
index 5ff027701..4be772c13 100644
--- a/core/core/src/services/ftp/core.rs
+++ b/core/services/ftp/src/core.rs
@@ -15,9 +15,10 @@
// specific language governing permissions and limitations
// under the License.
+use std::sync::Arc;
+
use fastpool::{ManageObject, ObjectStatus, bounded};
use futures_rustls::TlsConnector;
-use std::sync::Arc;
use suppaftp::AsyncRustlsConnector;
use suppaftp::AsyncRustlsFtpStream;
use suppaftp::FtpError;
@@ -27,8 +28,8 @@ use suppaftp::rustls::ClientConfig;
use suppaftp::types::FileType;
use super::err::format_ftp_error;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct FtpCore {
info: Arc<AccessorInfo>,
diff --git a/core/core/src/services/ftp/deleter.rs
b/core/services/ftp/src/deleter.rs
similarity index 97%
rename from core/core/src/services/ftp/deleter.rs
rename to core/services/ftp/src/deleter.rs
index 10b688912..88f6b956d 100644
--- a/core/core/src/services/ftp/deleter.rs
+++ b/core/services/ftp/src/deleter.rs
@@ -23,8 +23,8 @@ use suppaftp::types::Response;
use super::core::FtpCore;
use super::err::format_ftp_error;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct FtpDeleter {
core: Arc<FtpCore>,
diff --git a/core/core/src/services/ftp/docs.md b/core/services/ftp/src/docs.md
similarity index 95%
rename from core/core/src/services/ftp/docs.md
rename to core/services/ftp/src/docs.md
index fd91df685..0d6791c5c 100644
--- a/core/core/src/services/ftp/docs.md
+++ b/core/services/ftp/src/docs.md
@@ -27,8 +27,8 @@ You can refer to [`FtpBuilder`]'s docs for more information
```rust,no_run
use anyhow::Result;
-use opendal_core::services::Ftp;
use opendal_core::Operator;
+use opendal_service_ftp::Ftp;
#[tokio::main]
async fn main() -> Result<()> {
diff --git a/core/core/src/services/ftp/err.rs b/core/services/ftp/src/err.rs
similarity index 96%
rename from core/core/src/services/ftp/err.rs
rename to core/services/ftp/src/err.rs
index a2ea33674..a92cb18c6 100644
--- a/core/core/src/services/ftp/err.rs
+++ b/core/services/ftp/src/err.rs
@@ -18,8 +18,8 @@
use suppaftp::FtpError;
use suppaftp::Status;
-use crate::Error;
-use crate::ErrorKind;
+use opendal_core::Error;
+use opendal_core::ErrorKind;
pub(super) fn format_ftp_error(err: FtpError) -> Error {
let (kind, retryable) = match err {
diff --git a/core/core/src/services/ftp/mod.rs b/core/services/ftp/src/lib.rs
similarity index 96%
rename from core/core/src/services/ftp/mod.rs
rename to core/services/ftp/src/lib.rs
index cead8f392..c812d83dc 100644
--- a/core/core/src/services/ftp/mod.rs
+++ b/core/services/ftp/src/lib.rs
@@ -18,7 +18,7 @@
/// Default scheme for ftp service.
pub const FTP_SCHEME: &str = "ftp";
-use crate::types::DEFAULT_OPERATOR_REGISTRY;
+use opendal_core::DEFAULT_OPERATOR_REGISTRY;
mod backend;
mod config;
diff --git a/core/core/src/services/ftp/lister.rs
b/core/services/ftp/src/lister.rs
similarity index 97%
rename from core/core/src/services/ftp/lister.rs
rename to core/services/ftp/src/lister.rs
index 2e57e8abe..b850ba741 100644
--- a/core/core/src/services/ftp/lister.rs
+++ b/core/services/ftp/src/lister.rs
@@ -21,8 +21,8 @@ use std::vec::IntoIter;
use suppaftp::list::File;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct FtpLister {
path: String,
diff --git a/core/core/src/services/ftp/reader.rs
b/core/services/ftp/src/reader.rs
similarity index 98%
rename from core/core/src/services/ftp/reader.rs
rename to core/services/ftp/src/reader.rs
index 144b03d2b..163203bed 100644
--- a/core/core/src/services/ftp/reader.rs
+++ b/core/services/ftp/src/reader.rs
@@ -22,8 +22,8 @@ use futures::AsyncReadExt;
use super::core::Manager;
use super::err::format_ftp_error;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct FtpReader {
/// Keep the connection alive while data stream is alive.
diff --git a/core/core/src/services/ftp/writer.rs
b/core/services/ftp/src/writer.rs
similarity index 98%
rename from core/core/src/services/ftp/writer.rs
rename to core/services/ftp/src/writer.rs
index 838e0dda7..e5e759c67 100644
--- a/core/core/src/services/ftp/writer.rs
+++ b/core/services/ftp/src/writer.rs
@@ -22,8 +22,8 @@ use futures::AsyncWriteExt;
use super::core::Manager;
use super::err::format_ftp_error;
-use crate::raw::*;
-use crate::*;
+use opendal_core::raw::*;
+use opendal_core::*;
pub struct FtpWriter {
target_path: String,
diff --git a/core/src/lib.rs b/core/src/lib.rs
index e65dd6e51..c0ee7a289 100644
--- a/core/src/lib.rs
+++ b/core/src/lib.rs
@@ -37,6 +37,8 @@ pub mod services {
pub use opendal_service_azfile::*;
#[cfg(feature = "services-cloudflare-kv")]
pub use opendal_service_cloudflare_kv::*;
+ #[cfg(feature = "services-ftp")]
+ pub use opendal_service_ftp::*;
#[cfg(feature = "services-ghac")]
pub use opendal_service_ghac::*;
#[cfg(feature = "services-hdfs-native")]
