CYB::Exception::SystemData Class Reference

Exceptions caused by external call failures or invalid external data. Only classifies ones that can pass through the ABI. More...

#include <Exception.hpp>

Inheritance diagram for CYB::Exception::SystemData:

Collaboration diagram for CYB::Exception::SystemData:

Public Types
enum	ErrorCode : unsigned int {   DIRECTORY_NOT_EMPTY, FILE_EXISTS, FILE_NOT_FOUND, STREAM_NOT_READABLE,   STREAM_NOT_WRITABLE, HEAP_ALLOCATION_FAILURE, MUTEX_INITIALIZATION_FAILURE, PATH_LOST,   PATH_TOO_LONG, STRING_VALIDATION_FAILURE, SYSTEM_PATH_RETRIEVAL_FAILURE, THREAD_CREATION_FAILURE }
	The error code of the exception. More...
Public Types inherited from CYB::Exception::Base
enum	Level : byte { Level::VIOLATION, Level::SYSTEM_DATA, Level::INTERNAL, Level::UNIT }
	The extended type of the exception. More...

Public Member Functions
	SystemData (const ErrorCode AErrorCode) noexcept
	Construct a SystemData exception. More...

Static Private Member Functions
static API::String::Static	ErrorMessage (const ErrorCode AErrorCode) noexcept
	Get the associated message for an exception. More...

Additional Inherited Members
Public Attributes inherited from CYB::Exception::Base
API::String::Static	FMessage
	An english description of the error, guaranteed to be compatible with CYB::API::String::UTF8.
const unsigned int	FErrorCode
	The assigned error code.
const Level	FLevel
	The type of the exception.
Protected Member Functions inherited from CYB::Exception::Base
	Base (API::String::Static &&AMessage, const unsigned int AErrorCode, const Level ALevel) noexcept
	Construct a Base exception. More...

Detailed Description

Exceptions caused by external call failures or invalid external data. Only classifies ones that can pass through the ABI.

Definition at line 65 of file Exception.hpp.

Member Enumeration Documentation

enum CYB::Exception::SystemData::ErrorCode : unsigned int

The error code of the exception.

Enumerator
DIRECTORY_NOT_EMPTY	Tried to delete a non-empty directory.
FILE_EXISTS	A file that was to be created exists.
FILE_NOT_FOUND	A required file was not found in the filesystem.
STREAM_NOT_READABLE	Generic error for read failures. See functions for further documentation.
STREAM_NOT_WRITABLE	Generic error for write failures. See functions for further documentation.
HEAP_ALLOCATION_FAILURE	A heap has no block large enough for a requested allocation and expansion failed.
MUTEX_INITIALIZATION_FAILURE	Mutex could not be created.
PATH_LOST	A previously valid path has become invalidated, most likely due to deletion.
PATH_TOO_LONG	Attempted to use a path greater than the maximum allowed byte value.
STRING_VALIDATION_FAILURE	A string could not be validated.
SYSTEM_PATH_RETRIEVAL_FAILURE	A system path could not be retrieved.
THREAD_CREATION_FAILURE	Thread could not be created.

Definition at line 68 of file Exception.hpp.

                           : unsigned int {
                DIRECTORY_NOT_EMPTY,    
                FILE_EXISTS, 
                FILE_NOT_FOUND, 
                STREAM_NOT_READABLE,    
                STREAM_NOT_WRITABLE,    
                HEAP_ALLOCATION_FAILURE,    
                MUTEX_INITIALIZATION_FAILURE, 
                PATH_LOST,  
                PATH_TOO_LONG,  
                STRING_VALIDATION_FAILURE, 
                SYSTEM_PATH_RETRIEVAL_FAILURE, 
                THREAD_CREATION_FAILURE, 
            };

Constructor & Destructor Documentation

CYB::Exception::SystemData::SystemData ( const ErrorCode  AErrorCode )

noexcept

Construct a SystemData exception.

Parameters

AErrorCode

The ErrorCode describing the exception

Thread Safety

This function requires no thread safety

Exceptions

CYB::Exception::Violation

Error code: CYB::Exception::Violation::INVALID_EXCEPTION_CODE. Thrown if AErrorCode is not recognized by the engine

Attention

This function is for internal use only

Definition at line 86 of file CYBException.cpp.

                                                                      :
    Base(ErrorMessage(AErrorCode), AErrorCode, Level::SYSTEM_DATA)
{
    FLastInstantiatedExceptionCode = AErrorCode;
}

Member Function Documentation

CYB::API::String::Static CYB::Exception::SystemData::ErrorMessage ( const ErrorCode  AErrorCode )

staticprivatenoexcept

Get the associated message for an exception.

Parameters

AErrorCode

The ErrorCode describing the exception

Returns

A description of the exception indicated by AErrorCode

Thread Safety

This function requires no thread safety

Exceptions

CYB::Exception::Violation

Error code: CYB::Exception::Violation::INVALID_EXCEPTION_CODE. Thrown if AErrorCode is not recognized by the engine

Definition at line 42 of file CYBException.cpp.

                                                                                           {
    API::Assert::LessThanOrEqual(AErrorCode, THREAD_CREATION_FAILURE);
    API::String::Static ErrorMessage;
    switch (AErrorCode) {
    case DIRECTORY_NOT_EMPTY:
        ErrorMessage = API::String::Static(u8"Tried to delete a non-empty directory");
        break;
    case FILE_EXISTS:
        ErrorMessage = API::String::Static(u8"Tried to exclusively create a file that exists");
        break;
    case FILE_NOT_FOUND:
        ErrorMessage = API::String::Static(u8"A required file was not found.");
        break;
    case STREAM_NOT_READABLE:
        ErrorMessage = API::String::Static(u8"Generic error for read failures. See functions for further documentation");
        break;
    case STREAM_NOT_WRITABLE:
        ErrorMessage = API::String::Static(u8"Generic error for write failures. See functions for further documentation");
        break;
    case HEAP_ALLOCATION_FAILURE:
        ErrorMessage = API::String::Static(u8"Current heap has no block large enough for a requested allocation and expansion failed");
        break;
    case MUTEX_INITIALIZATION_FAILURE:
        ErrorMessage = API::String::Static(u8"Failed to initialize a new mutex.");
        break;
    case PATH_LOST:
        ErrorMessage = API::String::Static(u8"Path has become invalidated, most likely due to deletion");
        break;
    case PATH_TOO_LONG:
        ErrorMessage = API::String::Static(u8"Attempted to use a path greater than the maximum allowed byte value");
        break;
    case STRING_VALIDATION_FAILURE:
        ErrorMessage = API::String::Static(u8"A string could not be validated");
        break;
    case SYSTEM_PATH_RETRIEVAL_FAILURE:
        ErrorMessage = API::String::Static(u8"A system path could not be retrieved");
        break;
    case THREAD_CREATION_FAILURE:
        ErrorMessage = API::String::Static(u8"OS failed to create requested thread.");
        break;
    }
    return ErrorMessage;
}

---

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

• Engine/API/Types/Exception.hpp
• Engine/Engine/Core/CYBException.cpp