StormByte::System::FileIOError Class Reference

A file could not be opened for read or write. More...

#include <StormByte/system/exception.hxx>

Inheritance diagram for StormByte::System::FileIOError:

Collaboration diagram for StormByte::System::FileIOError:

Public Types
enum class	Operation { Read = 0 , Write }
	Failed file operation. More...

Public Member Functions
	FileIOError (const std::filesystem::path &file, const Operation &operation)
	Construct from a path and an operation.
	FileIOError (const FileIOError &)=default
	Copy constructor.
	FileIOError (FileIOError &&) noexcept=default
	Move constructor.
FileIOError &	operator= (const FileIOError &)=default
	Copy assignment.
FileIOError &	operator= (FileIOError &&)=default
	Move assignment.
	~FileIOError () noexcept override=default
	Destructor.
Public Member Functions inherited from StormByte::System::Exception
	Exception (const std::string &message)
	Plain-message constructor tagged with the System component.
template<typename... Args>
	Exception (std::format_string< Args... > fmt, Args &&... args)
	Format-string constructor tagged with the System component.
	Exception (const Exception &)=default
	Copy constructor.
	Exception (Exception &&) noexcept=default
	Move constructor.
Exception &	operator= (const Exception &)=default
	Copy assignment.
Exception &	operator= (Exception &&) noexcept=default
	Move assignment.
virtual	~Exception () noexcept override=default
	Destructor.

Static Public Member Functions
static constexpr const char *	operation_to_string (const Operation &op) noexcept
	Operation as text.

Detailed Description

A file could not be opened for read or write.

Member Enumeration Documentation

Operation

enum class StormByte::System::FileIOError::Operation

strong

Failed file operation.

Enumerator
Read	Open for reading.
Write	Open for writing.

Constructor & Destructor Documentation

FileIOError() [1/3]

StormByte::System::FileIOError::FileIOError ( const std::filesystem::path &  file, const Operation &  operation  )

inline

Construct from a path and an operation.

Parameters

file	File path.
operation	Failed operation.

FileIOError() [2/3]

StormByte::System::FileIOError::FileIOError ( const FileIOError &  )

default

Copy constructor.

FileIOError() [3/3]

StormByte::System::FileIOError::FileIOError ( FileIOError &&  )

defaultnoexcept

Move constructor.

~FileIOError()

StormByte::System::FileIOError::~FileIOError ( )

overridedefaultnoexcept

Destructor.

Member Function Documentation

operation_to_string()

static constexpr const char * StormByte::System::FileIOError::operation_to_string ( const Operation &  op )

inlinestaticconstexprnoexcept

Operation as text.

Parameters

op	Operation.

Returns

"read", "write", or "unknown".

operator=() [1/2]

FileIOError & StormByte::System::FileIOError::operator= ( const FileIOError &  )

default

Copy assignment.

operator=() [2/2]

FileIOError & StormByte::System::FileIOError::operator= ( FileIOError &&  )

default

Move assignment.

---

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

• lib/public/StormByte/system/exception.hxx