opendal_core/docs/performance/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//! OpenDAL Performance Guide
19//!
20//! OpenDAL keeps the storage abstraction lightweight, but applications still
21//! need to configure buffering, concurrency, and HTTP transport for their
22//! workload. This guide gives concrete Rust configuration examples and explains
23//! the trade-offs behind them.
24//!
25//! - [Concurrent writes][concurrent_write] explains how OpenDAL schedules write
26//! parts and how to tune `concurrent` and `chunk`.
27//! - [HTTP optimization][http_optimization] explains when to try HTTP/1.1 and
28//! how to configure DNS, timeouts, and connection pools.
29
30#[doc = include_str!("concurrent_write.md")]
31pub mod concurrent_write {}
32
33#[doc = include_str!("http_optimization.md")]
34pub mod http_optimization {}