This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch delete-recursive
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/delete-recursive by this push:
new 307f8b12e5 Reduce confusion
307f8b12e5 is described below
commit 307f8b12e56a88b285d78a8a2aa39e1ef6cb35a5
Author: Xuanwo <[email protected]>
AuthorDate: Sat Jan 6 11:37:39 2024 +0800
Reduce confusion
Signed-off-by: Xuanwo <[email protected]>
---
core/src/docs/rfcs/3911_deleter_api.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/core/src/docs/rfcs/3911_deleter_api.md
b/core/src/docs/rfcs/3911_deleter_api.md
index 1fdf0a7c07..9e73f39add 100644
--- a/core/src/docs/rfcs/3911_deleter_api.md
+++ b/core/src/docs/rfcs/3911_deleter_api.md
@@ -31,15 +31,17 @@ So I propose `Deleter` to address them all at once.
The following new API will be added to `Operator`:
-```rust
+```diff
impl Operator {
- pub async fn delete_with(&self, path: &str) -> FutureDelete;
+ pub async fn detele(&self, path: &str) -> Result<()>;
++ pub async fn delete_with(&self, path: &str) -> FutureDelete;
- pub async fn deleter(&self) -> Result<Deleter>;
- pub async fn deleter_with(&self) -> FutureDeleter;
++ pub async fn deleter(&self) -> Result<Deleter>;
++ pub async fn deleter_with(&self) -> FutureDeleter;
}
```
+- `delete` is the existing API, which deletes a single file or an empty dir.
- `delete_with` is an extension of the existing `delete` API, which supports
additional options, such as `recursive`.
- `deleter` is a new API that returns a `Deleter` instance.
- `deleter_with` is an extension of the existing `deleter` API, which supports
additional options, such as `recursive`.
@@ -118,7 +120,7 @@ In response to `Deleter` API, we will remove APIs like
`remove`, `remove_via` an
# Reference-level explanation
-We will add a new associated type in `Accessor`:
+To provide those public APIs, we will add a new associated type in `Accessor`:
```rust
trait Accessor {
