From d8968a45e5c17e25186c075f554d518fb620d110 Mon Sep 17 00:00:00 2001 From: Casey Bodley Date: Tue, 27 Nov 2018 09:46:17 -0500 Subject: [PATCH] librados_cxx: document which nobjects interfaces throw Signed-off-by: Casey Bodley --- src/include/rados/librados.hpp | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/src/include/rados/librados.hpp b/src/include/rados/librados.hpp index 80a0bb33673..f38877d7616 100644 --- a/src/include/rados/librados.hpp +++ b/src/include/rados/librados.hpp @@ -109,18 +109,19 @@ namespace librados bool operator!=(const NObjectIterator& rhs) const; const ListObject& operator*() const; const ListObject* operator->() const; - NObjectIterator &operator++(); // Preincrement - NObjectIterator operator++(int); // Postincrement + NObjectIterator &operator++(); //< Preincrement; errors are thrown as exceptions + NObjectIterator operator++(int); //< Postincrement; errors are thrown as exceptions friend class IoCtx; friend class NObjectIteratorImpl; /// get current hash position of the iterator, rounded to the current pg uint32_t get_pg_hash_position() const; - /// move the iterator to a given hash position. this may (will!) be rounded to the nearest pg. + /// move the iterator to a given hash position. this may (will!) be rounded + /// to the nearest pg. errors are thrown as exceptions uint32_t seek(uint32_t pos); - /// move the iterator to a given cursor position + /// move the iterator to a given cursor position. errors are thrown as exceptions uint32_t seek(const ObjectCursor& cursor); /// get current cursor position @@ -890,12 +891,14 @@ namespace librados std::list *lockers); - /// Start enumerating objects for a pool + /// Start enumerating objects for a pool. Errors are thrown as exceptions. NObjectIterator nobjects_begin(const bufferlist &filter=bufferlist()); - /// Start enumerating objects for a pool starting from a hash position + /// Start enumerating objects for a pool starting from a hash position. + /// Errors are thrown as exceptions. NObjectIterator nobjects_begin(uint32_t start_hash_position, const bufferlist &filter=bufferlist()); - /// Start enumerating objects for a pool starting from cursor + /// Start enumerating objects for a pool starting from cursor. Errors are + /// thrown as exceptions. NObjectIterator nobjects_begin(const librados::ObjectCursor& cursor, const bufferlist &filter=bufferlist()); /// Iterator indicating the end of a pool -- 2.39.5