Skip to main content

opendal_service_ftp/
lib.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
18#![doc = include_str!("../README.md")]
19#![cfg_attr(docsrs, feature(doc_cfg))]
20#![cfg_attr(docsrs, doc(auto_cfg))]
21#![deny(missing_docs)]
22
23/// URI scheme used for service registration and scheme-driven construction.
24pub const FTP_SCHEME: &str = "ftp";
25
26/// Register this service's URI scheme or schemes with an operator registry.
27///
28/// Registration enables scheme-driven construction through
29/// [`opendal_core::Operator::from_uri`] and
30/// [`opendal_core::Operator::via_iter`]. Direct construction through
31/// [`opendal_core::Operator::new`] does not require registration.
32pub fn register_ftp_service(registry: &opendal_core::OperatorRegistry) {
33    registry.register::<Ftp>(FTP_SCHEME);
34}
35
36mod backend;
37mod config;
38mod core;
39mod deleter;
40mod lister;
41mod reader;
42mod writer;
43
44pub use backend::FtpBuilder as Ftp;
45pub use config::FtpConfig;