DotNameLib
Loading...
Searching...
No Matches
dotnamecpp::utils::IFileWriter Class Referenceabstract

Interface for writing file content. More...

#include <IFileWriter.hpp>

Inheritance diagram for dotnamecpp::utils::IFileWriter:
Collaboration diagram for dotnamecpp::utils::IFileWriter:

Public Member Functions

virtual ~IFileWriter ()=default
virtual Result< void, FileErrorwrite (const std::filesystem::path &filePath, const std::string &content, bool append=false) const =0
 Write string content to file.
virtual Result< void, FileErrorwriteBytes (const std::filesystem::path &filePath, const std::vector< uint8_t > &data, bool append=false) const =0
 Write binary data to file.
virtual Result< void, FileErrorwriteLines (const std::filesystem::path &filePath, const std::vector< std::string > &lines, bool append=false) const =0
 Write lines to file (each string becomes one line)
virtual Result< void, FileErrortouch (const std::filesystem::path &filePath) const =0
 Create empty file or update timestamp of existing file.

Detailed Description

Interface for writing file content.

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

Constructor & Destructor Documentation

◆ ~IFileWriter()

virtual dotnamecpp::utils::IFileWriter::~IFileWriter ( )
virtualdefault

Member Function Documentation

◆ touch()

virtual Result< void, FileError > dotnamecpp::utils::IFileWriter::touch ( const std::filesystem::path & filePath) const
nodiscardpure virtual

Create empty file or update timestamp of existing file.

Parameters
filePath
Returns
Result<void, FileError>

Implemented in dotnamecpp::utils::FileWriter.

◆ write()

virtual Result< void, FileError > dotnamecpp::utils::IFileWriter::write ( const std::filesystem::path & filePath,
const std::string & content,
bool append = false ) const
nodiscardpure virtual

Write string content to file.

Parameters
filePath
content
append
Returns
Result<void, FileError>

Implemented in dotnamecpp::utils::FileWriter.

◆ writeBytes()

virtual Result< void, FileError > dotnamecpp::utils::IFileWriter::writeBytes ( const std::filesystem::path & filePath,
const std::vector< uint8_t > & data,
bool append = false ) const
nodiscardpure virtual

Write binary data to file.

Parameters
filePath
data
append
Returns
Result<void, FileError>

Implemented in dotnamecpp::utils::FileWriter.

◆ writeLines()

virtual Result< void, FileError > dotnamecpp::utils::IFileWriter::writeLines ( const std::filesystem::path & filePath,
const std::vector< std::string > & lines,
bool append = false ) const
nodiscardpure virtual

Write lines to file (each string becomes one line)

Parameters
filePath
lines
append
Returns
Result<void, FileError>

Implemented in dotnamecpp::utils::FileWriter.


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