StormByte::Config::FailureHook Class Reference

Stateful hook run when text parse fails. More...

#include <StormByte/config/hook.hxx>

Inheritance diagram for StormByte::Config::FailureHook:

Collaboration diagram for StormByte::Config::FailureHook:

Public Member Functions
	FailureHook () noexcept=default
	Constructor.
	FailureHook (const FailureHook &hook) noexcept=default
	Copy constructor.
	FailureHook (FailureHook &&hook) noexcept=default
	Move constructor.
FailureHook &	operator= (const FailureHook &hook) noexcept=default
	Assignment operator.
FailureHook &	operator= (FailureHook &&hook) noexcept=default
	Move assignment operator.
	~FailureHook () noexcept override
	Destructor.
PointerType	Clone () const override=0
	Clone.
PointerType	Move () override=0
	Move.
virtual bool	operator() (const Item::Group &root)=0
	Invoke the hook.
Public Member Functions inherited from StormByte::Clonable< FailureHook, StormByte::Shared< FailureHook > >
constexpr	Clonable ()=default
constexpr	Clonable (const Clonable &)=default
constexpr	Clonable (Clonable &&) noexcept=default
constexpr Clonable &	operator= (const Clonable &)=default
constexpr Clonable &	operator= (Clonable &&) noexcept=default
virtual constexpr	~Clonable () noexcept=default

Additional Inherited Members
Public Types inherited from StormByte::Clonable< FailureHook, StormByte::Shared< FailureHook > >
typedef SmartPointer	PointerType
Static Public Member Functions inherited from StormByte::Clonable< FailureHook, StormByte::Shared< FailureHook > >
static PointerType	MakePointer (Args &&... args)

Detailed Description

Stateful hook run when text parse fails.

Return false to swallow the error; true to keep throwing.

Constructor & Destructor Documentation

FailureHook() [1/3]

StormByte::Config::FailureHook::FailureHook ( )

defaultnoexcept

Constructor.

FailureHook() [2/3]

StormByte::Config::FailureHook::FailureHook ( const FailureHook &  hook )

defaultnoexcept

Copy constructor.

Parameters

hook	hook to copy

FailureHook() [3/3]

StormByte::Config::FailureHook::FailureHook ( FailureHook &&  hook )

defaultnoexcept

Move constructor.

Parameters

hook	hook to move

~FailureHook()

StormByte::Config::FailureHook::~FailureHook ( )

overridenoexcept

Destructor.

Defined in this module so catch matches across a DLL.

Member Function Documentation

Clone()

PointerType StormByte::Config::FailureHook::Clone ( ) const

overridepure virtual

Clone.

Returns

pointer

Implements StormByte::Clonable< FailureHook, StormByte::Shared< FailureHook > >.

Move()

PointerType StormByte::Config::FailureHook::Move ( )

overridepure virtual

Move.

Returns

pointer

Implements StormByte::Clonable< FailureHook, StormByte::Shared< FailureHook > >.

operator()()

virtual bool StormByte::Config::FailureHook::operator() ( const Item::Group &  root )

pure virtual

Invoke the hook.

Parameters

root	Document root (possibly partial).

Returns

true to propagate the parse error.

operator=() [1/2]

FailureHook & StormByte::Config::FailureHook::operator= ( const FailureHook &  hook )

defaultnoexcept

Assignment operator.

Parameters

hook	hook to copy

Returns

this

operator=() [2/2]

FailureHook & StormByte::Config::FailureHook::operator= ( FailureHook &&  hook )

defaultnoexcept

Move assignment operator.

Parameters

hook	hook to move

Returns

this

---

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

• lib/public/StormByte/config/hook.hxx