hal::utils::RecursiveDirectoryRange Class Reference

#include <utils.h>

Collaboration diagram for hal::utils::RecursiveDirectoryRange:

Public Types
using	iterator = std::filesystem::recursive_directory_iterator

Public Member Functions
	RecursiveDirectoryRange (std::filesystem::path path)
iterator	begin ()
iterator	end ()

Detailed Description

A recursive range of directories starting at a top level root directory.

Definition at line 690 of file utils.h.

Member Typedef Documentation

iterator

using hal::utils::RecursiveDirectoryRange::iterator = std::filesystem::recursive_directory_iterator

Definition at line 693 of file utils.h.

Constructor & Destructor Documentation

RecursiveDirectoryRange()

hal::utils::RecursiveDirectoryRange::RecursiveDirectoryRange ( std::filesystem::path  path )

inline

Construct a recursive directory range from a top level directory.

Parameters

[in]

path

- The path to the top level directory.

Definition at line 700 of file utils.h.

Member Function Documentation

begin()

iterator hal::utils::RecursiveDirectoryRange::begin ( )

inline

Get an iterator pointing to the first element in the top level directory.
The iterator will iterate recursively through all elements inside the top level container.

Returns

The iterator.

Definition at line 710 of file utils.h.

end()

iterator hal::utils::RecursiveDirectoryRange::end ( )

inline

Get an iterator pointing behind the last element in the top level directory.

Returns

The iterator.

Definition at line 720 of file utils.h.

---

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

• /home/runner/work/hal/hal/include/hal_core/utilities/utils.h