hal::utils::DirectoryRange Class Reference

#include <utils.h>

Collaboration diagram for hal::utils::DirectoryRange:

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

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

Detailed Description

A range of directories within the top level root directory.

Definition at line 732 of file utils.h.

Member Typedef Documentation

iterator

using hal::utils::DirectoryRange::iterator = std::filesystem::directory_iterator

Definition at line 735 of file utils.h.

Constructor & Destructor Documentation

DirectoryRange()

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

inline

Construct a directory range from a top level directory.

Parameters

[in]

path

- The top level directory.

Definition at line 742 of file utils.h.

Member Function Documentation

begin()

iterator hal::utils::DirectoryRange::begin ( )

inline

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

Returns

The iterator.

Definition at line 753 of file utils.h.

end()

iterator hal::utils::DirectoryRange::end ( )

inline

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

Returns

The iterator.

Definition at line 763 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