galaxy 1.0.0
Real-Time C++23 Game Programming Framework. Built on data-driven design principles and agile software engineering.
Loading...
Searching...
No Matches
galaxy::FileError Class Referencefinal

Stores information about a File I/O error. More...

#include <FileError.hpp>

+ Collaboration diagram for galaxy::FileError:

Public Member Functions

 FileError () noexcept
 Constructor.
 
 FileError (const std::string &mode, const std::string &reason, const std::filesystem::path &path) noexcept
 Argument constructor.
 
 ~FileError () noexcept
 Destructor.
 
void log () const noexcept
 Prints the file error in a nice format to the console.
 

Public Attributes

std::string m_mode
 File I/O mode.
 
std::string m_reason
 Reason for file i/o failure.
 
std::filesystem::path m_path
 Path error occured on.
 

Detailed Description

Stores information about a File I/O error.

Definition at line 19 of file FileError.hpp.

Constructor & Destructor Documentation

◆ FileError() [1/2]

galaxy::FileError::FileError ( )
noexcept

Constructor.

Definition at line 14 of file FileError.cpp.

◆ FileError() [2/2]

galaxy::FileError::FileError ( const std::string & mode,
const std::string & reason,
const std::filesystem::path & path )
noexcept

Argument constructor.

Parameters
modeFile I/O i.e. read/write.
reasonError failure.
pathPath where I/O failed.

Definition at line 18 of file FileError.cpp.

◆ ~FileError()

galaxy::FileError::~FileError ( )
noexcept

Destructor.

Definition at line 25 of file FileError.cpp.

Member Function Documentation

◆ log()

void galaxy::FileError::log ( ) const
noexcept

Prints the file error in a nice format to the console.

Definition at line 29 of file FileError.cpp.

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_mode

std::string galaxy::FileError::m_mode

File I/O mode.

Definition at line 50 of file FileError.hpp.

◆ m_reason

std::string galaxy::FileError::m_reason

Reason for file i/o failure.

Definition at line 55 of file FileError.hpp.

◆ m_path

std::filesystem::path galaxy::FileError::m_path

Path error occured on.

Definition at line 60 of file FileError.hpp.


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