This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 7d3aa6450 doc: apply `range_reader` change in upgrade doc (#3401)
7d3aa6450 is described below
commit 7d3aa645012ebc393add06c9147ed4e7561d6f52
Author: congyi wang <[email protected]>
AuthorDate: Fri Oct 27 13:00:46 2023 +0800
doc: apply `range_reader` change in upgrade doc (#3401)
* update upgrade doc v0.40
* minor
---
core/src/docs/upgrade.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/core/src/docs/upgrade.md b/core/src/docs/upgrade.md
index e061fdc25..d80e6b26f 100644
--- a/core/src/docs/upgrade.md
+++ b/core/src/docs/upgrade.md
@@ -91,6 +91,22 @@ let mut w = op.writer_with("path/to/file").buffer(8 * 1024 *
1024).await?;
If buffer is not specified, we will call underlying storage everytime we call
`write`. Otherwise, we will make sure to call underlying storage when buffer is
full or `close` is called.
+### RangeRead and RangeReader
+
+OpenDAL v0.40 removed the origin `range_read` and `range_reader` interfaces,
please use `read_with().range()` or `reader_with().range()`.
+
+```diff
+- op.range_read(path, range_start..range_end).await?;
++ op.read_with(path).range(range_start..range_end).await?;
+```
+
+```diff
+- let reader = op.range_reader(path, range_start..range_end).await?;
++ let reader = op.reader_with(path).range(range_start..range_end).await?;
+```
+
+
+
## Raw API
### RFC-3017 Remove Write Copy From