dotnamecpp::utils::IFileReader Class Reference

Interface for reading file content. More...

#include <IFileReader.hpp>

Inheritance diagram for dotnamecpp::utils::IFileReader:

Collaboration diagram for dotnamecpp::utils::IFileReader:

Public Member Functions
virtual	~IFileReader ()=default
virtual Result< std::string, FileError >	read (const std::filesystem::path &filePath) const =0
	Read the entire content of a file as a string.
virtual Result< std::vector< uint8_t >, FileError >	readBytes (const std::filesystem::path &filePath) const =0
	Read the entire content of a file as a vector of bytes.
virtual Result< std::vector< std::string >, FileError >	readLines (const std::filesystem::path &filePath) const =0
	Read the content of a file as a vector of lines.
virtual bool	exists (const std::filesystem::path &filePath) const =0
	Check if a file exists.
virtual Result< std::uintmax_t, FileError >	getSize (const std::filesystem::path &filePath) const =0
	Get the Size object.

Detailed Description

Interface for reading file content.

Provides abstraction for file reading operations with explicit error handling. All methods return Result<T, FileError> for safe error handling.

Constructor & Destructor Documentation

~IFileReader()

virtual dotnamecpp::utils::IFileReader::~IFileReader ( )

virtualdefault

Member Function Documentation

exists()

virtual bool dotnamecpp::utils::IFileReader::exists ( const std::filesystem::path & filePath ) const

nodiscardpure virtual

Check if a file exists.

Parameters

filePath

Returns

true

false

Implemented in dotnamecpp::utils::FileReader.

getSize()

virtual Result< std::uintmax_t, FileError > dotnamecpp::utils::IFileReader::getSize ( const std::filesystem::path & filePath ) const

nodiscardpure virtual

Get the Size object.

Parameters

filePath

Returns

Result<std::uintmax_t, FileError>

Implemented in dotnamecpp::utils::FileReader.

read()

virtual Result< std::string, FileError > dotnamecpp::utils::IFileReader::read ( const std::filesystem::path & filePath ) const

nodiscardpure virtual

Read the entire content of a file as a string.

Parameters

filePath

Returns

Result<std::string, FileError>

Implemented in dotnamecpp::utils::FileReader.

readBytes()

virtual Result< std::vector< uint8_t >, FileError > dotnamecpp::utils::IFileReader::readBytes ( const std::filesystem::path & filePath ) const

nodiscardpure virtual

Read the entire content of a file as a vector of bytes.

Parameters

filePath

Returns

Result<std::vector<uint8_t>, FileError>

Implemented in dotnamecpp::utils::FileReader.

readLines()

virtual Result< std::vector< std::string >, FileError > dotnamecpp::utils::IFileReader::readLines ( const std::filesystem::path & filePath ) const

nodiscardpure virtual

Read the content of a file as a vector of lines.

Parameters

filePath

Returns

Result<std::vector<std::string>, FileError>

Implemented in dotnamecpp::utils::FileReader.

---

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

• src/Utils/Filesystem/IFileReader.hpp