Skip to content

Commit bd5d4a5

Browse files
authored
chore: update docs to delineate which are recursive (#5794)
1 parent 5e9919f commit bd5d4a5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

object_store/src/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@ pub trait ObjectStore: std::fmt::Display + Send + Sync + Debug + 'static {
716716
/// List all the objects with the given prefix.
717717
///
718718
/// Prefixes are evaluated on a path segment basis, i.e. `foo/bar/` is a prefix of `foo/bar/x` but not of
719-
/// `foo/bar_baz/x`.
719+
/// `foo/bar_baz/x`. List is recursive, i.e. `foo/bar/more/x` will be included.
720720
///
721721
/// Note: the order of returned [`ObjectMeta`] is not guaranteed
722722
fn list(&self, prefix: Option<&Path>) -> BoxStream<'_, Result<ObjectMeta>>;
@@ -743,7 +743,7 @@ pub trait ObjectStore: std::fmt::Display + Send + Sync + Debug + 'static {
743743
/// metadata.
744744
///
745745
/// Prefixes are evaluated on a path segment basis, i.e. `foo/bar/` is a prefix of `foo/bar/x` but not of
746-
/// `foo/bar_baz/x`.
746+
/// `foo/bar_baz/x`. List is not recursive, i.e. `foo/bar/more/x` will not be included.
747747
async fn list_with_delimiter(&self, prefix: Option<&Path>) -> Result<ListResult>;
748748

749749
/// Copy an object from one path to another in the same object store.

0 commit comments

Comments
 (0)