StormByte::Config::ReadHook Class Reference

Stateful hook run before/after a successful text read. More...

#include <StormByte/config/hook.hxx>

Inheritance diagram for StormByte::Config::ReadHook:

Collaboration diagram for StormByte::Config::ReadHook:

Public Member Functions
	ReadHook () noexcept=default
	Constructor.
	ReadHook (const ReadHook &hook) noexcept=default
	Copy constructor.
	ReadHook (ReadHook &&hook) noexcept=default
	Move constructor.
ReadHook &	operator= (const ReadHook &hook) noexcept=default
	Assignment operator.
ReadHook &	operator= (ReadHook &&hook) noexcept=default
	Move assignment operator.
	~ReadHook () noexcept override
	Destructor.
PointerType	Clone () const override=0
	Clone.
PointerType	Move () override=0
	Move.
virtual void	operator() (Item::Group &root)=0
	Invoke the hook.
Public Member Functions inherited from StormByte::Clonable< ReadHook, StormByte::Shared< ReadHook > >
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< ReadHook, StormByte::Shared< ReadHook > >
typedef SmartPointer	PointerType
Static Public Member Functions inherited from StormByte::Clonable< ReadHook, StormByte::Shared< ReadHook > >
static PointerType	MakePointer (Args &&... args)

Detailed Description

Stateful hook run before/after a successful text read.

Derive and construct with MakePointer when the hook needs state. Stateless callbacks use the function-pointer overloads on Config.

Constructor & Destructor Documentation

ReadHook() [1/3]

StormByte::Config::ReadHook::ReadHook ( )

defaultnoexcept

Constructor.

ReadHook() [2/3]

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

defaultnoexcept

Copy constructor.

Parameters

hook	hook to copy

ReadHook() [3/3]

StormByte::Config::ReadHook::ReadHook ( ReadHook &&  hook )

defaultnoexcept

Move constructor.

Parameters

hook	hook to move

~ReadHook()

StormByte::Config::ReadHook::~ReadHook ( )

overridenoexcept

Destructor.

Defined in this module so catch matches across a DLL.

Member Function Documentation

Clone()

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

overridepure virtual

Clone.

Returns

pointer

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

Move()

PointerType StormByte::Config::ReadHook::Move ( )

overridepure virtual

Move.

Returns

pointer

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

operator()()

virtual void StormByte::Config::ReadHook::operator() ( Item::Group &  root )

pure virtual

Invoke the hook.

Parameters

root	Document root.

operator=() [1/2]

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

defaultnoexcept

Assignment operator.

Parameters

hook	hook to copy

Returns

this

operator=() [2/2]

ReadHook & StormByte::Config::ReadHook::operator= ( ReadHook &&  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