bson_iter_recurse(3)

bson_iter_recurse3

Usage

bool
bson_iter_recurse (const bson_iter_t *iter, bson_iter_t *child);

Parameters

•

iter: A bson_iter_t.

•

child: A bson_iter_t.

Overview

The bson_iter_recurse() function shall initialize child using the embedded document or array currently observed by iter.

If there was a failure to initialize the iter, false is returned and both iter and child should be considered invalid.

This should only be called when observing an element of type BSON_TYPE_ARRAY or BSON_TYPE_DOCUMENT.

Returns

If iter observes an element of type BSON_TYPE_ARRAY or BSON_TYPE_DOCUMENT, then child is initialized and the function returns true. Otherwise, the function returns false and child is invalid.

Releases

5 releases since Debian 9 (Stretch); the text changed 4 times.

  1. 9
  2. 10
  3. 11
  4. 12
  5. 13

Author

MongoDB, Inc

From libbson-doc 1.30.4-1+deb13u3 in Debian 13 (Trixie). Parsed by carta from the page's man source.