File: mongoc_matcher_match.rst

package info (click to toggle)
mongo-c-driver 1.17.6-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 37,256 kB
  • sloc: ansic: 152,613; javascript: 7,954; python: 3,259; sh: 138; makefile: 29; xml: 10
file content (33 lines) | stat: -rw-r--r-- 683 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
:man_page: mongoc_matcher_match

mongoc_matcher_match()
======================

Synopsis
--------

.. code-block:: c

  bool
  mongoc_matcher_match (const mongoc_matcher_t *matcher, const bson_t *document);

This function will check to see if the query compiled in ``matcher`` matches ``document``.

Deprecated
----------

.. warning::

  ``mongoc_matcher_t`` is deprecated and will be removed in version 2.0.

Parameters
----------

* ``matcher``: A :symbol:`mongoc_matcher_t`.
* ``query``: A :symbol:`bson:bson_t` that contains the query.

Returns
-------

``true`` if ``document`` matches the query specification provided to :symbol:`mongoc_matcher_new()`. Otherwise, ``false``.