opendal::Lister Class Reference

Lister is designed to list the entries of a directory. More...

#include <opendal.hpp>

Classes
class	Iterator

Public Member Functions
	Lister (Lister &&other) noexcept
	~Lister () noexcept
std::optional< Entry >	Next ()
	Get the next entry of the lister.
Iterator	begin ()
Iterator	end ()

Friends
class	Operator

Detailed Description

Lister is designed to list the entries of a directory.

It provides next operation to get the next entry. You can also use it like an iterator.

auto lister = operator.lister("dir/");
for (const auto &entry : lister) {
  // Do something with entry
}

Constructor & Destructor Documentation

Lister()

opendal::Lister::Lister ( Lister &&  other )

noexcept

~Lister()

opendal::Lister::~Lister ( )

noexcept

Member Function Documentation

begin()

Iterator opendal::Lister::begin ( )

inline

end()

Iterator opendal::Lister::end ( )

inline

Next()

std::optional< Entry > opendal::Lister::Next

(

)

Get the next entry of the lister.

Returns

The next entry of the lister

Friends And Related Symbol Documentation

Operator

friend class Operator

friend

---

The documentation for this class was generated from the following file:

• /home/runner/work/opendal/opendal/bindings/cpp/include/opendal.hpp