opendal/raw/adapters/
mod.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//! Providing adapters and its implementations.
19//!
20//! Adapters in OpenDAL means services that shares similar behaviors. We use
21//! adapter to make those services been implemented more easily. For example,
22//! with [`kv::Adapter`], users only need to implement `get`, `set` for a service.
23//!
24//! # Notes
25//!
26//! Please import the module instead of its type.
27//!
28//! For example, use the following:
29//!
30//! ```ignore
31//! use opendal::adapters::kv;
32//!
33//! impl kv::Adapter for MyType {}
34//! ```
35//!
36//! Instead of:
37//!
38//! ```ignore
39//! use opendal::adapters::kv::Adapter;
40//!
41//! impl Adapter for MyType {}
42//! ```
43//!
44//! # Available Adapters
45//!
46//! - [`kv::Adapter`]: Adapter for Key Value Services like `redis`.
47//! - [`typed_kv::Adapter`]: Adapter key value services that in-memory.
48
49pub mod kv;
50pub mod typed_kv;
opendal/raw/adapters/mod.rs

opendal/raw/adapters/
mod.rs
