opendal::Lister Class Reference

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

#include <opendal.hpp>

Classes
class	ListerIterator
	ListerIterator is an iterator of Lister. More...

Public Member Functions
	Lister (rust::Box< opendal::ffi::Lister > &&lister)
std::optional< Entry >	next ()
	Get the next entry of the lister.
ListerIterator	begin ()
ListerIterator	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()

opendal::Lister::Lister ( rust::Box< opendal::ffi::Lister > &&  lister )

inline

Member Function Documentation

begin()

ListerIterator opendal::Lister::begin ( )

inline

end()

ListerIterator 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