:orphan:

.. index:: pair: struct; te_buf_pattern
.. _doxid-structte__buf__pattern:

struct te_buf_pattern
=====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Compiled buffer fill pattern. :ref:`More...<details-structte__buf__pattern>`


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

	#include <te_bufs.h>
	
	struct te_buf_pattern {
		// fields
	
		uint8_t* :ref:`start<doxid-structte__buf__pattern_1ac96ccebb8a3324756ad227409d77884f>`;
		uint8_t* :ref:`end<doxid-structte__buf__pattern_1ac1b1e4b5c83c55abb3165109b4a45d20>`;
		uint8_t* :ref:`repeat<doxid-structte__buf__pattern_1a90147540902b7df655b62f6733dc65d6>`;
		uint8_t* :ref:`suffix<doxid-structte__buf__pattern_1a7bd6ed2ff34c9723f6191fcc81a4c1a6>`;
		size_t :ref:`suffix_len<doxid-structte__buf__pattern_1a42498ae6882f4687911fe192fd2f4a7b>`;
	};
.. _details-structte__buf__pattern:

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

Compiled buffer fill pattern.

The structure should be treated as opaque and only filled by :ref:`te_compile_buf_pattern() <doxid-group__te__tools__te__bufs_1gaa4275bb7d02946345ae3921d8724319d>`.

The compiled pattern is a sequence of "possible bytes", where each "possible byte" is a number followed by that many byte values. If the number is zero, any byte is possible at that position.

Fields
------

.. index:: pair: variable; start
.. _doxid-structte__buf__pattern_1ac96ccebb8a3324756ad227409d77884f:

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

	uint8_t* start

Start of the pattern bytes.

.. index:: pair: variable; end
.. _doxid-structte__buf__pattern_1ac1b1e4b5c83c55abb3165109b4a45d20:

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

	uint8_t* end

End of the pattern bytes.

.. index:: pair: variable; repeat
.. _doxid-structte__buf__pattern_1a90147540902b7df655b62f6733dc65d6:

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

	uint8_t* repeat

Repeating part of the pattern bytes.

.. index:: pair: variable; suffix
.. _doxid-structte__buf__pattern_1a7bd6ed2ff34c9723f6191fcc81a4c1a6:

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

	uint8_t* suffix

Suffix part of the pattern bytes.

.. index:: pair: variable; suffix_len
.. _doxid-structte__buf__pattern_1a42498ae6882f4687911fe192fd2f4a7b:

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

	size_t suffix_len

Number of bytes generated by *suffix*.