Skip to content

Commit

Permalink
chore: update docs to delineate which are recursive (#5794)
Browse files Browse the repository at this point in the history
  • Loading branch information
wiedld authored May 23, 2024
1 parent 5e9919f commit bd5d4a5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions object_store/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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>>;
Expand All @@ -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.
Expand Down

0 comments on commit bd5d4a5

Please sign in to comment.