:orphan:

.. index:: pair: group; Substring manipulation API
.. _doxid-group__te__tools__te__substring:

Substring manipulation API
==========================

.. toctree::
	:hidden:

	struct_te_substring_t.rst

Overview
~~~~~~~~




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

	
	// typedefs

	typedef struct :ref:`te_substring_t<doxid-structte__substring__t>` :ref:`te_substring_t<doxid-group__te__tools__te__substring_1gaad61d17007089da720d9d0b428de3476>`;

	// structs

	struct :ref:`te_substring_t<doxid-structte__substring__t>`;

	// global functions

	static bool :ref:`te_substring_is_valid<doxid-group__te__tools__te__substring_1gaff2ae7d38f9062d40f5029b24ce6405e>`(const :ref:`te_substring_t<doxid-structte__substring__t>`* substr);
	void :ref:`te_substring_find<doxid-group__te__tools__te__substring_1ga084e46bfc9b4a091b56e01cffdc93644>`(:ref:`te_substring_t<doxid-structte__substring__t>`* substr, const char* str);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_substring_replace<doxid-group__te__tools__te__substring_1ga85958bcc9020daf024cd4f6e475f58c9>`(:ref:`te_substring_t<doxid-structte__substring__t>`* substr, const char* str);
	void :ref:`te_substring_advance<doxid-group__te__tools__te__substring_1gaaf6dd7c24ceb50a0361d49146bcd00ce>`(:ref:`te_substring_t<doxid-structte__substring__t>`* substr);
	void :ref:`te_substring_limit<doxid-group__te__tools__te__substring_1ga647fe2ff923c3fece8849f900faff72f>`(:ref:`te_substring_t<doxid-structte__substring__t>`* substr, const :ref:`te_substring_t<doxid-structte__substring__t>`* limit);

	// macros

	#define :ref:`TE_SUBSTRING_INIT<doxid-group__te__tools__te__substring_1ga0e56cb1ec7ef54241d85620a24c9d2d0>`(_base)

.. _details-group__te__tools__te__substring:

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



Typedefs
--------

.. index:: pair: typedef; te_substring_t
.. _doxid-group__te__tools__te__substring_1gaad61d17007089da720d9d0b428de3476:

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

	typedef struct :ref:`te_substring_t<doxid-structte__substring__t>` te_substring_t

Structure for describing a piece of string

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

.. index:: pair: function; te_substring_is_valid
.. _doxid-group__te__tools__te__substring_1gaff2ae7d38f9062d40f5029b24ce6405e:

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

	static bool te_substring_is_valid(const :ref:`te_substring_t<doxid-structte__substring__t>`* substr)

Check that substring is valid



.. rubric:: Parameters:

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

	*
		- substr

		- Substring



.. rubric:: Returns:

``true`` or ``false``

.. index:: pair: function; te_substring_find
.. _doxid-group__te__tools__te__substring_1ga084e46bfc9b4a091b56e01cffdc93644:

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

	void te_substring_find(:ref:`te_substring_t<doxid-structte__substring__t>`* substr, const char* str)

Find a ``str`` starting at ``substr`` position and update it accordingly



.. rubric:: Parameters:

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

	*
		- substr

		- Substring

	*
		- str

		- The string to find

.. index:: pair: function; te_substring_replace
.. _doxid-group__te__tools__te__substring_1ga85958bcc9020daf024cd4f6e475f58c9:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` te_substring_replace(:ref:`te_substring_t<doxid-structte__substring__t>`* substr, const char* str)

Replace a substring at a given position, modifying the underlying ``:ref:`te_string <doxid-structte__string>```



.. rubric:: Parameters:

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

	*
		- substr

		- Substring

	*
		- str

		- Replacement string

	*
		- TE_EINVAL

		- Substring position is out of bounds.



.. rubric:: Returns:

Status code.

.. index:: pair: function; te_substring_advance
.. _doxid-group__te__tools__te__substring_1gaaf6dd7c24ceb50a0361d49146bcd00ce:

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

	void te_substring_advance(:ref:`te_substring_t<doxid-structte__substring__t>`* substr)

Move the position by the length of the previously substring



.. rubric:: Parameters:

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

	*
		- substr

		- Substring

.. index:: pair: function; te_substring_limit
.. _doxid-group__te__tools__te__substring_1ga647fe2ff923c3fece8849f900faff72f:

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

	void te_substring_limit(:ref:`te_substring_t<doxid-structte__substring__t>`* substr, const :ref:`te_substring_t<doxid-structte__substring__t>`* limit)

Limit the length of the ``substr`` to position ``limit`` so that it ended right before ``limit``



.. rubric:: Parameters:

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

	*
		- substr

		- Substring

	*
		- limit

		- Limiting substring

Macros
------

.. index:: pair: define; TE_SUBSTRING_INIT
.. _doxid-group__te__tools__te__substring_1ga0e56cb1ec7ef54241d85620a24c9d2d0:

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

	#define TE_SUBSTRING_INIT(_base)

Substring initializer



.. rubric:: Parameters:

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

	*
		- _base

		- Pointer to the base string