1BSON_ITER_RECURSE(3) libbson BSON_ITER_RECURSE(3)
2
3
4
6 bool
7 bson_iter_recurse (const bson_iter_t *iter, bson_iter_t *child);
8
10 • iter: A bson_iter_t.
11
12 • child: A bson_iter_t.
13
15 The bson_iter_recurse() function shall initialize child using the em‐
16 bedded document or array currently observed by iter.
17
18 If there was a failure to initialize the iter, false is returned and
19 both iter and child should be considered invalid.
20
21 This should only be called when observing an element of type
22 BSON_TYPE_ARRAY or BSON_TYPE_DOCUMENT.
23
25 If iter observes an element of type BSON_TYPE_ARRAY or BSON_TYPE_DOCU‐
26 MENT, then child is initialized and the function returns true. Other‐
27 wise, the function returns false and child is invalid.
28
30 MongoDB, Inc
31
33 2017-present, MongoDB, Inc
34
35
36
37
381.25.1 Nov 08, 2023 BSON_ITER_RECURSE(3)