:orphan:

.. index:: pair: group; HEX diff dump API
.. _doxid-group__te__tools__te__hex__diff__dump:

HEX diff dump API
=================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Functions to format a hex diff dump of two binary memory blocks and log it. :ref:`More...<details-group__te__tools__te__hex__diff__dump>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// global functions

	void :ref:`te_hex_diff_dump<doxid-group__te__tools__te__hex__diff__dump_1ga46f0ef40d9dcee2c870db2e6a30a8fbd>`(const void* expected, size_t exp_len, const void* actual, size_t actual_len, size_t offset, :ref:`te_string<doxid-structte__string>`* dest);
	void :ref:`te_hex_diff_log<doxid-group__te__tools__te__hex__diff__dump_1ga47cc9f9d95efe104353d7ebe2f51b6f0>`(const void* expected, size_t exp_len, const void* actual, size_t actual_len, size_t offset, const char* file, int line, unsigned int level, const char* entity, const char* user);

	// macros

	#define :ref:`LOG_HEX_DIFF_DUMP<doxid-group__te__tools__te__hex__diff__dump_1ga82e8a6b213f49ab0095016d60b32e800>`(_lvl, _expected, _actual, _len)
	#define :ref:`LOG_HEX_DIFF_DUMP_AT<doxid-group__te__tools__te__hex__diff__dump_1gae81f2a12e75d02dec113eb71de6ad871>`(_lvl, _expected, _explen, _actual, _actlen, _offset)

.. _details-group__te__tools__te__hex__diff__dump:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Functions to format a hex diff dump of two binary memory blocks and log it.

Global Functions
----------------

.. index:: pair: function; te_hex_diff_dump
.. _doxid-group__te__tools__te__hex__diff__dump_1ga46f0ef40d9dcee2c870db2e6a30a8fbd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void te_hex_diff_dump(const void* expected, size_t exp_len, const void* actual, size_t actual_len, size_t offset, :ref:`te_string<doxid-structte__string>`* dest)

Format the difference between ``expected`` and ``actual`` and put the dump into ``dest``.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- expected

		- Buffer with the expected data.

	*
		- exp_len

		- Length of the expected buffer.

	*
		- actual

		- Buffer with the actual data.

	*
		- actual_len

		- Length of the actual buffer.

	*
		- offset

		- The offset of the buffers (only affects logging).

	*
		- dest

		- Destination string.

.. index:: pair: function; te_hex_diff_log
.. _doxid-group__te__tools__te__hex__diff__dump_1ga47cc9f9d95efe104353d7ebe2f51b6f0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void te_hex_diff_log(const void* expected, size_t exp_len, const void* actual, size_t actual_len, size_t offset, const char* file, int line, unsigned int level, const char* entity, const char* user)

Log the difference between ``expected`` and ``actual`` with the specified log ``level`` and ``user``.

The formatting is done by :ref:`te_hex_diff_dump() <doxid-group__te__tools__te__hex__diff__dump_1ga46f0ef40d9dcee2c870db2e6a30a8fbd>`.

Usually the function shall not be used directly, but through the macro :ref:`LOG_HEX_DIFF_DUMP_AT() <doxid-group__te__tools__te__hex__diff__dump_1gae81f2a12e75d02dec113eb71de6ad871>` or :ref:`LOG_HEX_DIFF_DUMP() <doxid-group__te__tools__te__hex__diff__dump_1ga82e8a6b213f49ab0095016d60b32e800>`.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- expected

		- Buffer with the expected data.

	*
		- exp_len

		- Length of the expected buffer.

	*
		- actual

		- Buffer with the actual data.

	*
		- actual_len

		- Length of the actual buffer.

	*
		- offset

		- The offset of the buffers (only affects logging).

	*
		- level

		- Log level

	*
		- entity

		- Log entity

	*
		- user

		- Log user

Macros
------

.. index:: pair: define; LOG_HEX_DIFF_DUMP
.. _doxid-group__te__tools__te__hex__diff__dump_1ga82e8a6b213f49ab0095016d60b32e800:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define LOG_HEX_DIFF_DUMP(_lvl, _expected, _actual, _len)

Log the difference between buffers with a given log level.

The buffers are assumed to be at offset 0 and be of the same length.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _lvl

		- Log level for the diff.

	*
		- _expected

		- Buffer with expected data.

	*
		- _actual

		- Buffer with actual data.

	*
		- _len

		- Length of buffers.



.. rubric:: See also:

:ref:`LOG_HEX_DIFF_DUMP_AT <doxid-group__te__tools__te__hex__diff__dump_1gae81f2a12e75d02dec113eb71de6ad871>`

.. index:: pair: define; LOG_HEX_DIFF_DUMP_AT
.. _doxid-group__te__tools__te__hex__diff__dump_1gae81f2a12e75d02dec113eb71de6ad871:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	#define LOG_HEX_DIFF_DUMP_AT(_lvl, _expected, _explen, _actual, _actlen, _offset)

Log the difference between buffers with a given log level.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- _lvl

		- Log level for the diff.

	*
		- _expected

		- Buffer with expected data.

	*
		- _explen

		- The length of the expected buffer.

	*
		- _actual

		- Buffer with actual data.

	*
		- _actlen

		- The length of the actual buffer.

	*
		- _offset

		- The offset of the buffers (only affects logging).



.. rubric:: See also:

:ref:`te_hex_diff_log <doxid-group__te__tools__te__hex__diff__dump_1ga47cc9f9d95efe104353d7ebe2f51b6f0>`