opendal_service_cos/
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 COS_SCHEME: &str = "cos";
25
26/// Alternative scheme for cos service.
27///
28/// `cosn://` is the canonical Hadoop / EMR URI scheme used by many
29/// big-data ecosystems (Spark, Hive, Flink, etc.) to access Tencent Cloud
30/// COS. OpenDAL accepts it as an alias of `cos://` so that existing
31/// workloads can switch to OpenDAL without changing their URIs.
32pub const COSN_SCHEME: &str = "cosn";
33
34/// Register this service's URI scheme or schemes with an operator registry.
35///
36/// Registration enables scheme-driven construction through
37/// [`opendal_core::Operator::from_uri`] and
38/// [`opendal_core::Operator::via_iter`]. Direct construction through
39/// [`opendal_core::Operator::new`] does not require registration.
40///
41/// Both the canonical `cos` scheme and the Hadoop-compatible `cosn`
42/// alias are registered so that URIs like `cos://bucket/key` and
43/// `cosn://bucket/key` are both resolvable to this backend.
44pub fn register_cos_service(registry: &opendal_core::OperatorRegistry) {
45    registry.register::<Cos>(COS_SCHEME);
46    registry.register::<Cos>(COSN_SCHEME);
47}
48
49mod backend;
50mod config;
51mod core;
52mod deleter;
53mod lister;
54mod reader;
55mod writer;
56
57pub use backend::CosBuilder as Cos;
58pub use config::CosConfig;
opendal_service_cos/lib.rs

opendal_service_cos/
lib.rs
