DotNameLib
Loading...
Searching...
No Matches
dotnamecpp::utils::DirectoryManager Class Referencefinal

Standard implementation of IDirectoryManager interface. More...

#include <DirectoryManager.hpp>

Inheritance diagram for dotnamecpp::utils::DirectoryManager:
Collaboration diagram for dotnamecpp::utils::DirectoryManager:

Public Member Functions

 DirectoryManager ()=default
 DirectoryManager (const DirectoryManager &)=delete
DirectoryManageroperator= (const DirectoryManager &)=delete
 DirectoryManager (DirectoryManager &&)=delete
DirectoryManageroperator= (DirectoryManager &&)=delete
 ~DirectoryManager () override=default
Result< void, FileErrorcreateDirectory (const std::filesystem::path &dirPath) const override
 Create a Directory object.
Result< void, FileErrorremoveDirectory (const std::filesystem::path &dirPath) const override
 Remove a Directory object.
Result< std::uintmax_t, FileErrorremoveDirectoryRecursive (const std::filesystem::path &dirPath) const override
 Remove a Directory object recursively.
bool exists (const std::filesystem::path &dirPath) const override
 Check if a directory exists.
Result< bool, FileErrorisEmpty (const std::filesystem::path &dirPath) const override
 Check if a directory is empty.
Result< std::vector< std::filesystem::path >, FileErrorlistEntries (const std::filesystem::path &dirPath) const override
 List entries in a directory.
Result< std::vector< std::filesystem::path >, FileErrorlistEntriesRecursive (const std::filesystem::path &dirPath) const override
 List entries in a directory recursively.
Result< std::filesystem::path, FileErrorgetCurrentDirectory () const override
 Get the Current Directory object.
Result< std::filesystem::path, FileErrorgetTempDirectory () const override
 Get the Temp Directory object.
Public Member Functions inherited from dotnamecpp::utils::IDirectoryManager
virtual ~IDirectoryManager ()=default

Detailed Description

Standard implementation of IDirectoryManager interface.

Constructor & Destructor Documentation

◆ DirectoryManager() [1/3]

dotnamecpp::utils::DirectoryManager::DirectoryManager ( )
default
Here is the caller graph for this function:

◆ DirectoryManager() [2/3]

dotnamecpp::utils::DirectoryManager::DirectoryManager ( const DirectoryManager & )
delete
Here is the call graph for this function:

◆ DirectoryManager() [3/3]

dotnamecpp::utils::DirectoryManager::DirectoryManager ( DirectoryManager && )
delete
Here is the call graph for this function:

◆ ~DirectoryManager()

dotnamecpp::utils::DirectoryManager::~DirectoryManager ( )
overridedefault

Member Function Documentation

◆ createDirectory()

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

Create a Directory object.

Parameters
dirPath
Returns
Result<void, FileError>

Implements dotnamecpp::utils::IDirectoryManager.

◆ exists()

bool dotnamecpp::utils::DirectoryManager::exists ( const std::filesystem::path & dirPath) const
nodiscardoverridevirtual

Check if a directory exists.

Parameters
dirPath
Returns
true
false

Implements dotnamecpp::utils::IDirectoryManager.

◆ getCurrentDirectory()

Result< std::filesystem::path, FileError > dotnamecpp::utils::DirectoryManager::getCurrentDirectory ( ) const
nodiscardoverridevirtual

Get the Current Directory object.

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

Implements dotnamecpp::utils::IDirectoryManager.

◆ getTempDirectory()

Result< std::filesystem::path, FileError > dotnamecpp::utils::DirectoryManager::getTempDirectory ( ) const
nodiscardoverridevirtual

Get the Temp Directory object.

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

Implements dotnamecpp::utils::IDirectoryManager.

◆ isEmpty()

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

Check if a directory is empty.

Parameters
dirPath
Returns
Result<bool, FileError>

Implements dotnamecpp::utils::IDirectoryManager.

◆ listEntries()

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

List entries in a directory.

Parameters
dirPath
Returns
Result<std::vector<std::filesystem::path>, FileError>

Implements dotnamecpp::utils::IDirectoryManager.

◆ listEntriesRecursive()

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

List entries in a directory recursively.

Parameters
dirPath
Returns
Result<std::vector<std::filesystem::path>, FileError>

Implements dotnamecpp::utils::IDirectoryManager.

◆ operator=() [1/2]

DirectoryManager & dotnamecpp::utils::DirectoryManager::operator= ( const DirectoryManager & )
delete
Here is the call graph for this function:

◆ operator=() [2/2]

DirectoryManager & dotnamecpp::utils::DirectoryManager::operator= ( DirectoryManager && )
delete
Here is the call graph for this function:

◆ removeDirectory()

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

Remove a Directory object.

Parameters
dirPath
Returns
Result<void, FileError>

Implements dotnamecpp::utils::IDirectoryManager.

◆ removeDirectoryRecursive()

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

Remove a Directory object recursively.

Parameters
dirPath
Returns
Result<std::uintmax_t, FileError>

Implements dotnamecpp::utils::IDirectoryManager.


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