:man_page: bson_init_from_json

bson_init_from_json()
=====================

Synopsis
--------

.. code-block:: c

  bool
  bson_init_from_json (bson_t *bson,
                       const char *data,
                       ssize_t len,
                       bson_error_t *error);

Parameters
----------

* ``bson``: Pointer to an uninitialized :symbol:`bson_t`.
* ``data``: A UTF-8 encoded string containing valid JSON.
* ``len``: The length of ``data`` in bytes excluding a trailing ``\0`` or -1 to determine the length with ``strlen()``.
* ``error``: An optional location for a :symbol:`bson_error_t`.

Description
-----------

The ``bson_init_from_json()`` function will initialize a new :symbol:`bson_t` by parsing the JSON found in ``data``. Only a single JSON object may exist in ``data`` or an error will be set and false returned.

``data`` should be in `MongoDB Extended JSON <https://docs.mongodb.com/manual/reference/mongodb-extended-json/>`_ format.

Errors
------

Errors are propagated via the ``error`` parameter.

Returns
-------

Returns ``true`` if valid JSON was parsed, otherwise ``false`` and ``error`` is set. On success, ``bson`` is initialized and must be freed with :symbol:`bson_destroy`, otherwise ``bson`` is invalid.

.. only:: html

  .. taglist:: See Also:
    :tags: create-bson json
