dotnamecpp::utils::IDirectoryManager Class Reference

Interface for directory operations. More...

#include <IDirectoryManager.hpp>

Inheritance diagram for dotnamecpp::utils::IDirectoryManager:

Collaboration diagram for dotnamecpp::utils::IDirectoryManager:

Public Member Functions
virtual	~IDirectoryManager ()=default
virtual Result< void, FileError >	createDirectory (const std::filesystem::path &dirPath) const =0
	Create a Directory object.
virtual Result< void, FileError >	removeDirectory (const std::filesystem::path &dirPath) const =0
	Remove a Directory object.
virtual Result< std::uintmax_t, FileError >	removeDirectoryRecursive (const std::filesystem::path &dirPath) const =0
	Remove a Directory object recursively.
virtual bool	exists (const std::filesystem::path &dirPath) const =0
	Check if a directory exists.
virtual Result< bool, FileError >	isEmpty (const std::filesystem::path &dirPath) const =0
	Check if a directory is empty.
virtual Result< std::vector< std::filesystem::path >, FileError >	listEntries (const std::filesystem::path &dirPath) const =0
	List entries in a directory.
virtual Result< std::vector< std::filesystem::path >, FileError >	listEntriesRecursive (const std::filesystem::path &dirPath) const =0
	List entries in a directory recursively.
virtual Result< std::filesystem::path, FileError >	getCurrentDirectory () const =0
	Get the Current Directory object.
virtual Result< std::filesystem::path, FileError >	getTempDirectory () const =0
	Get the Temp Directory object.

Detailed Description

Interface for directory operations.

Provides abstraction for directory creation, removal, and listing.

Constructor & Destructor Documentation

~IDirectoryManager()

virtual dotnamecpp::utils::IDirectoryManager::~IDirectoryManager ( )

virtualdefault

Member Function Documentation

createDirectory()

virtual Result< void, FileError > dotnamecpp::utils::IDirectoryManager::createDirectory ( const std::filesystem::path & dirPath ) const

nodiscardpure virtual

Create a Directory object.

Parameters

dirPath

Returns

Result<void, FileError>

Implemented in dotnamecpp::utils::DirectoryManager.

exists()

virtual bool dotnamecpp::utils::IDirectoryManager::exists ( const std::filesystem::path & dirPath ) const

nodiscardpure virtual

Check if a directory exists.

Parameters

dirPath

Returns

true

false

Implemented in dotnamecpp::utils::DirectoryManager.

getCurrentDirectory()

virtual Result< std::filesystem::path, FileError > dotnamecpp::utils::IDirectoryManager::getCurrentDirectory ( ) const

nodiscardpure virtual

Get the Current Directory object.

Returns

Result<std::filesystem::path, FileError>

Implemented in dotnamecpp::utils::DirectoryManager.

getTempDirectory()

virtual Result< std::filesystem::path, FileError > dotnamecpp::utils::IDirectoryManager::getTempDirectory ( ) const

nodiscardpure virtual

Get the Temp Directory object.

Returns

Result<std::filesystem::path, FileError>

Implemented in dotnamecpp::utils::DirectoryManager.

isEmpty()

virtual Result< bool, FileError > dotnamecpp::utils::IDirectoryManager::isEmpty ( const std::filesystem::path & dirPath ) const

nodiscardpure virtual

Check if a directory is empty.

Parameters

dirPath

Returns

Result<bool, FileError>

Implemented in dotnamecpp::utils::DirectoryManager.

listEntries()

virtual Result< std::vector< std::filesystem::path >, FileError > dotnamecpp::utils::IDirectoryManager::listEntries ( const std::filesystem::path & dirPath ) const

nodiscardpure virtual

List entries in a directory.

Parameters

dirPath

Returns

Result<std::vector<std::filesystem::path>, FileError>

Implemented in dotnamecpp::utils::DirectoryManager.

listEntriesRecursive()

virtual Result< std::vector< std::filesystem::path >, FileError > dotnamecpp::utils::IDirectoryManager::listEntriesRecursive ( const std::filesystem::path & dirPath ) const

nodiscardpure virtual

List entries in a directory recursively.

Parameters

dirPath

Returns

Result<std::vector<std::filesystem::path>, FileError>

Implemented in dotnamecpp::utils::DirectoryManager.

removeDirectory()

virtual Result< void, FileError > dotnamecpp::utils::IDirectoryManager::removeDirectory ( const std::filesystem::path & dirPath ) const

nodiscardpure virtual

Remove a Directory object.

Parameters

dirPath

Returns

Result<void, FileError>

Implemented in dotnamecpp::utils::DirectoryManager.

removeDirectoryRecursive()

virtual Result< std::uintmax_t, FileError > dotnamecpp::utils::IDirectoryManager::removeDirectoryRecursive ( const std::filesystem::path & dirPath ) const

nodiscardpure virtual

Remove a Directory object recursively.

Parameters

dirPath

Returns

Result<std::uintmax_t, FileError>

Implemented in dotnamecpp::utils::DirectoryManager.

---

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

• src/Utils/Filesystem/IDirectoryManager.hpp