.. _l-functions:

Functions
=========

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| function                                       | class parent | truncated documentation                                                                                               |
+================================================+==============+=======================================================================================================================+
| :func:`_compile <_re2._compile>`               |              |                                                                                                                       |
+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`_setup_hook <wrapclib._setup_hook>`     |              | if this function is added to the module, the help automation and unit tests call it first before anything goes on ... |
+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`check <wrapclib.check>`                 |              | Checks the library is working. It raises an exception. If you want to disable the logs:                               |
+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`compile <wrapclib.re2.re2.compile>`     |              | Compiles a regular expression pattern, returning a pattern object.                                                    |
+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`escape <_re2.escape>`                   |              | Escape all potentially meaningful regexp characters.                                                                  |
+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`findall <wrapclib.re2.re2.findall>`     |              | Implements method :epkg:`*py:re:findall` for *re2* in :epkg:`Python`.                                                 |
+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`fullmatch <wrapclib.re2.re2.fullmatch>` |              | Tries to apply the pattern to the entire string, returning a match object, or None if no match was found.             |
+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`match <wrapclib.re2.re2.match>`         |              | Tries to apply the pattern at the start of the string, returning a match object, or None if no match was found.       |
+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`search <wrapclib.re2.re2.search>`       |              | Scans through string looking for a match to the pattern, returning a match object, or None if no match was found.     |
+------------------------------------------------+--------------+-----------------------------------------------------------------------------------------------------------------------+