StormByte::Buffer::ReadError Class Reference

Exception thrown when a buffer read / extract / peek operation fails. More...

#include <StormByte/buffer/exception.hxx>

Inheritance diagram for StormByte::Buffer::ReadError:

Collaboration diagram for StormByte::Buffer::ReadError:

Public Member Functions
	ReadError (const std::string &message)
	Construct a read error from an unformatted message.
	ReadError (std::string &&message)
	Construct a read error from a moved unformatted message.
template<typename... Args>
	ReadError (std::format_string< Args... > fmt, Args &&... args)
	Construct a read error with a format message.
Public Member Functions inherited from StormByte::Buffer::Error
	Exception (const std::string &message)
	Construct a Buffer exception from an unformatted message.
	Exception (std::string &&message)
	Construct a Buffer exception from a moved unformatted message.
template<typename... Args>
	Exception (StormByte::Component component, std::format_string< Args... > fmt, Args &&... args)
	Construct a Buffer exception with an explicit component.
template<typename... Args>
	Exception (std::format_string< Args... > fmt, Args &&... args)
	Construct a Buffer exception with a formatted message.
Public Member Functions inherited from StormByte::Buffer::Exception
	Exception (const std::string &message)
	Construct a Buffer exception from an unformatted message.
	Exception (std::string &&message)
	Construct a Buffer exception from a moved unformatted message.
template<typename... Args>
	Exception (StormByte::Component component, std::format_string< Args... > fmt, Args &&... args)
	Construct a Buffer exception with an explicit component.
template<typename... Args>
	Exception (std::format_string< Args... > fmt, Args &&... args)
	Construct a Buffer exception with a formatted message.

Detailed Description

Exception thrown when a buffer read / extract / peek operation fails.

The component name is fixed to "Buffer::ReadError".

Constructor & Destructor Documentation

ReadError() [1/3]

StormByte::Buffer::ReadError::ReadError ( const std::string &  message )

inlineexplicit

Construct a read error from an unformatted message.

Parameters

message

Exception text.

ReadError() [2/3]

StormByte::Buffer::ReadError::ReadError ( std::string &&  message )

inlineexplicit

Construct a read error from a moved unformatted message.

Parameters

message

Exception text.

ReadError() [3/3]

template<typename... Args>

StormByte::Buffer::ReadError::ReadError ( std::format_string< Args... >  fmt, Args &&...  args  )

inline

Construct a read error with a format message.

Template Parameters

Args	Format argument types.

Parameters

fmt	C++20 format string.
args	Format arguments.

---

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

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