This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch polish-lister
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/polish-lister by this push:
new aa70105d2 Fix header
new 08383bced Merge remote-tracking branch
'refs/remotes/origin/polish-lister' into polish-lister
aa70105d2 is described below
commit aa70105d265df3f3cee6c34a8f76fbea490266a4
Author: Xuanwo <[email protected]>
AuthorDate: Wed Nov 15 23:54:12 2023 +0800
Fix header
Signed-off-by: Xuanwo <[email protected]>
---
bindings/c/include/opendal.h | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/bindings/c/include/opendal.h b/bindings/c/include/opendal.h
index 0a5349a6a..38b3e531e 100644
--- a/bindings/c/include/opendal.h
+++ b/bindings/c/include/opendal.h
@@ -77,7 +77,10 @@ typedef enum opendal_code {
* BlockingLister is designed to list entries at given path in a blocking
* manner.
*
- * Users can construct Lister by `blocking_lister`.
+ * Users can construct Lister by [`BlockingOperator::lister`] or
[`BlockingOperator::lister_with`].
+ *
+ * - Lister implements `Iterator<Item = Result<Entry>>`.
+ * - Lister will return `None` if there is no more entries or error has been
returned.
*/
typedef struct BlockingLister BlockingLister;
