a c-style callbacks class. More...

#include <common.hpp>

Public Member Functions
	Callbacks ()
	Construct an object with the default callbacks. More...

	Callbacks (void *user_data, pfn_allocate alloc, pfn_free free, pfn_error error)
	Construct an object with the given callbacks. More...

bool	operator!= (Callbacks const &that) const

bool	operator== (Callbacks const &that) const

Public Attributes
void *	m_user_data

pfn_allocate	m_allocate

pfn_free	m_free

pfn_error	m_error

Detailed Description

a c-style callbacks class.

Can be used globally by the library and/or locally by Tree and Parser objects.

Definition at line 374 of file common.hpp.

Constructor & Destructor Documentation

◆ Callbacks() [1/2]

c4::yml::Callbacks::Callbacks ( )

Construct an object with the default callbacks.

If RYML_NO_DEFAULT_CALLBACKS is defined, the object will have null members.

Definition at line 79 of file common.cpp.

     :
     m_user_data(nullptr),
     #ifndef RYML_NO_DEFAULT_CALLBACKS
     m_allocate(allocate_impl),
     m_free(free_impl),
     m_error(error_impl)
     #else
     m_allocate(nullptr),
     m_free(nullptr),
     m_error(nullptr)
     #endif
 {
 }

◆ Callbacks() [2/2]

c4::yml::Callbacks::Callbacks	(	void *	user_data,
		pfn_allocate	alloc,
		pfn_free	free,
		pfn_error	error
	)

Construct an object with the given callbacks.

Parameters

user_data	Data to be forwarded in every call to a callback.
alloc	A pointer to an allocate function. Unless RYML_NO_DEFAULT_CALLBACKS is defined, when this parameter is null, will fall back to ryml's default alloc implementation.
free	A pointer to a free function. Unless RYML_NO_DEFAULT_CALLBACKS is defined, when this parameter is null, will fall back to ryml's default free implementation.
error	A pointer to an error function, which must never return (see pfn_error). Unless RYML_NO_DEFAULT_CALLBACKS is defined, when this parameter is null, will fall back to ryml's default error implementation.

Definition at line 94 of file common.cpp.

     :
     m_user_data(user_data),
     #ifndef RYML_NO_DEFAULT_CALLBACKS
     m_allocate(alloc_ ? alloc_ : allocate_impl),
     m_free(free_ ? free_ : free_impl),
     m_error((error_ ? error_ : error_impl))
     #else
     m_allocate(alloc_),
     m_free(free_),
     m_error(error_)
     #endif
 {
     RYML_CHECK(m_allocate);
     RYML_CHECK(m_free);
     RYML_CHECK(m_error);
 }

References m_allocate, m_error, and m_free.

Member Function Documentation

◆ operator!=()

bool c4::yml::Callbacks::operator!= ( Callbacks const & that ) const

inline

Definition at line 408 of file common.hpp.

408 { return !operator==(that); }

c4::yml::Callbacks::operator==

bool operator==(Callbacks const &that) const

Definition: common.hpp:409

References c4::operator==().

◆ operator==()

bool c4::yml::Callbacks::operator== ( Callbacks const & that ) const

inline

Definition at line 409 of file common.hpp.

     {
         return (m_user_data == that.m_user_data &&
                 m_allocate == that.m_allocate &&
                 m_free == that.m_free &&
                 m_error == that.m_error);
     }

References m_allocate, m_error, m_free, and m_user_data.

Member Data Documentation

◆ m_user_data

void* c4::yml::Callbacks::m_user_data

Definition at line 376 of file common.hpp.

Referenced by sample::PerTreeMemoryExample::callbacks(), c4::yml::error(), and operator==().

◆ m_allocate

pfn_allocate c4::yml::Callbacks::m_allocate

Definition at line 377 of file common.hpp.

Referenced by Callbacks(), sample::PerTreeMemoryExample::callbacks(), sample::ErrorHandlerExample::check_effect(), operator==(), and sample::sample_global_allocator().

◆ m_free

pfn_free c4::yml::Callbacks::m_free

Definition at line 378 of file common.hpp.

Referenced by Callbacks(), sample::PerTreeMemoryExample::callbacks(), sample::ErrorHandlerExample::check_effect(), operator==(), and sample::sample_global_allocator().

◆ m_error

pfn_error c4::yml::Callbacks::m_error

Definition at line 379 of file common.hpp.

Referenced by Callbacks(), sample::ErrorHandlerExample::check_effect(), c4::yml::error(), and operator==().

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

/home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.7.0/src/c4/yml/common.hpp
/home/docs/checkouts/readthedocs.org/user_builds/rapidyaml/checkouts/v0.7.0/src/c4/yml/common.cpp

Public Member Functions

Public Attributes