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 (std::unique_ptr< details::Lister > lister)
	Lister (Lister &&)
	~Lister ()
std::optional< Entry >	next ()
	Get the next entry of the lister.
Iterator	begin ()
Iterator	end ()

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() [1/2]

opendal::Lister::Lister

(

std::unique_ptr< details::Lister >

lister

)

Lister() [2/2]

opendal::Lister::Lister

(

Lister &&

)

~Lister()

opendal::Lister::~Lister

(

)

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

---

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

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