refactor: Add FileIO::remove_dir_all to deprecate remove_dir #1275
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Xuanwo <[email protected]>
| @@ -95,9 +95,14 @@ impl FileIO { | |||
| /// # Arguments | |||
| /// | |||
| /// * path: It should be *absolute* path starting with scheme string used to construct [`FileIO`]. | |||
| pub async fn remove_all(&self, path: impl AsRef<str>) -> Result<()> { | |||
| pub async fn remove_dir_all(&self, path: impl AsRef<str>) -> Result<()> { | |||
There was a problem hiding this comment.
- It would be better to add doc to explain the behavior, e.g. what if the dir doesn't exist, what if the dir is empty.
- Add test case for path not ending with "/"
There was a problem hiding this comment.
maybe also add a test for if the path (without ending in /) refers to a file instead of dir. should be no-op
kevinjqliu
reviewed
May 5, 2025
| @@ -95,9 +95,14 @@ impl FileIO { | |||
| /// # Arguments | |||
| /// | |||
| /// * path: It should be *absolute* path starting with scheme string used to construct [`FileIO`]. | |||
| pub async fn remove_all(&self, path: impl AsRef<str>) -> Result<()> { | |||
| pub async fn remove_dir_all(&self, path: impl AsRef<str>) -> Result<()> { | |||
There was a problem hiding this comment.
is this a breaking change? i.e. something we should warn users about on the next release
There was a problem hiding this comment.
+1, we could deprecate the old one, and recommend the new api.
| @@ -95,9 +95,14 @@ impl FileIO { | |||
| /// # Arguments | |||
| /// | |||
| /// * path: It should be *absolute* path starting with scheme string used to construct [`FileIO`]. | |||
| pub async fn remove_all(&self, path: impl AsRef<str>) -> Result<()> { | |||
| pub async fn remove_dir_all(&self, path: impl AsRef<str>) -> Result<()> { | |||
There was a problem hiding this comment.
maybe also add a test for if the path (without ending in /) refers to a file instead of dir. should be no-op
|
Thank you all for the review, I will start addressing them today. |
Signed-off-by: Xuanwo <[email protected]>
Xuanwo
changed the title
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
remove_allbehavior for S3 #1118What changes are included in this PR?
Change FileIO::remove_all to remove_dir_all to make it's behavior more clear.
Are these changes tested?