This is an automated email from the ASF dual-hosted git repository.
tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new bd5d4a59db5 chore: update docs to delineate which are recursive (#5794)
bd5d4a59db5 is described below
commit bd5d4a59db5d6d0e1b3bdf00644dbaf317f3be03
Author: wiedld <[email protected]>
AuthorDate: Thu May 23 02:03:27 2024 -0700
chore: update docs to delineate which are recursive (#5794)
---
object_store/src/lib.rs | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/object_store/src/lib.rs b/object_store/src/lib.rs
index bdf870f45ab..1339d1c011e 100644
--- a/object_store/src/lib.rs
+++ b/object_store/src/lib.rs
@@ -716,7 +716,7 @@ pub trait ObjectStore: std::fmt::Display + Send + Sync +
Debug + 'static {
/// List all the objects with the given prefix.
///
/// Prefixes are evaluated on a path segment basis, i.e. `foo/bar/` is a
prefix of `foo/bar/x` but not of
- /// `foo/bar_baz/x`.
+ /// `foo/bar_baz/x`. List is recursive, i.e. `foo/bar/more/x` will be
included.
///
/// Note: the order of returned [`ObjectMeta`] is not guaranteed
fn list(&self, prefix: Option<&Path>) -> BoxStream<'_, Result<ObjectMeta>>;
@@ -743,7 +743,7 @@ pub trait ObjectStore: std::fmt::Display + Send + Sync +
Debug + 'static {
/// metadata.
///
/// Prefixes are evaluated on a path segment basis, i.e. `foo/bar/` is a
prefix of `foo/bar/x` but not of
- /// `foo/bar_baz/x`.
+ /// `foo/bar_baz/x`. List is not recursive, i.e. `foo/bar/more/x` will not
be included.
async fn list_with_delimiter(&self, prefix: Option<&Path>) ->
Result<ListResult>;
/// Copy an object from one path to another in the same object store.
