Skip to main content

opendal_service_s3/
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
23mod backend;
24mod config;
25mod copier;
26mod core;
27mod deleter;
28mod lister;
29mod reader;
30mod writer;
31
32pub use backend::S3Builder as S3;
33pub use config::S3Config;
34
35/// URI scheme used for service registration and scheme-driven construction.
36pub const S3_SCHEME: &str = "s3";
37
38/// Register this service's URI scheme or schemes with an operator registry.
39///
40/// Registration enables scheme-driven construction through
41/// [`opendal_core::Operator::from_uri`] and
42/// [`opendal_core::Operator::via_iter`]. Direct construction through
43/// [`opendal_core::Operator::new`] does not require registration.
44pub fn register_s3_service(registry: &opendal_core::OperatorRegistry) {
45    registry.register::<S3>(S3_SCHEME);
46}