Specialized exception type used for file related APIs. More...

#include <FileError.hxx>

Inheritance diagram for cosmos::FileError:

Public Member Functions
	FileError (const SysString path, const std::string_view operation)

Public Member Functions inherited from cosmos::ApiError
	ApiError (const std::string_view prefix)
	Stores the current errno code in the exception.

	ApiError (const std::string_view prefix, const Errno err)
	Stores the given errno code in the exception.

std::string	msg () const
	Returns the plain operating system error message.

auto	errnum () const
	Returns the plain errno stored in the exception.

Public Member Functions inherited from cosmos::CosmosError
	CosmosError (const std::string_view error_class, const std::string_view fixed_text={})

CosmosError &	setInfo (const char file, const size_t line, const char func)
	Set exception context information.

const char *	what () const override throw ()
	Implementation of the std::exception interface.

std::string	shortWhat () const
	Returns a shorter description of the error without verbose context.

virtual void	raise ()=0
	Throw the most specialized type of this object in the inheritance hierarchy.

Public Attributes
	COSMOS_ERROR_IMPL

Public Attributes inherited from cosmos::ApiError
	COSMOS_ERROR_IMPL

Protected Member Functions
void	generateMsg () const override
	Append type specific error information to m_msg.

Protected Member Functions inherited from cosmos::ApiError
Protected Member Functions inherited from cosmos::CosmosError
void	setErrorClass (const std::string_view error_class)
	Allows to override error class to allow simpler implementation of derived types.

Protected Attributes
std::string	m_path

std::string	m_operation

Protected Attributes inherited from cosmos::ApiError
Errno	m_errno = Errno::NO_ERROR

Protected Attributes inherited from cosmos::CosmosError
std::string_view	m_error_class
	Descriptive, unique error class label.

std::string	m_msg
	Runtime generated error message.

bool	m_msg_generated = false
	Whether m_msg has been assembled yet.

const char *	m_file = nullptr

const char *	m_func = nullptr

size_t	m_line = 0

Additional Inherited Members
Static Public Member Functions inherited from cosmos::ApiError
static std::string	msg (const Errno err)
	Returns a human readable error message for the given errno code.

Detailed Description

Specialized exception type used for file related APIs.

Compared to ApiError this error type also carries a custom runtime allocated path that refers to the file system location that caused the error.

This is somewhat more expensive but allows for better error messages in these special cases.

Definition at line 21 of file FileError.hxx.

Constructor & Destructor Documentation

◆ FileError()

cosmos::FileError::FileError	(	const SysString	path,
		const std::string_view	operation )

Definition at line 6 of file FileError.cxx.

                                                                         :
                ApiError({}),
                m_path{path}, m_operation{operation} {
        setErrorClass("FileError");
}

Member Function Documentation

◆ generateMsg()

void cosmos::FileError::generateMsg ( ) const

overrideprotectedvirtual

Append type specific error information to m_msg.

This function is called by the implementation when error specific information needs to be appended to the m_msg string.

At entry into this function m_msg can already contain data that must not be discarded.

This function will be called at most once during the lifetime of an object, and only if the error message actually needs to be generated due to a call to what().

Reimplemented from cosmos::ApiError.

Definition at line 12 of file FileError.cxx.

                                  {
        m_msg += m_path + ": " + m_operation + ": ";
        ApiError::generateMsg();
}

Member Data Documentation

◆ COSMOS_ERROR_IMPL

cosmos::FileError::COSMOS_ERROR_IMPL

Definition at line 27 of file FileError.hxx.

◆ m_operation

std::string cosmos::FileError::m_operation

protected

Definition at line 36 of file FileError.hxx.

◆ m_path

std::string cosmos::FileError::m_path

protected

Definition at line 35 of file FileError.hxx.

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

include/error/FileError.hxx
src/error/FileError.cxx

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members