bson_iter_init_from_data_at_offset man page

bson_iter_init_from_data_at_offset ā€” bson_iter_init_from_data_at_offset()

Synopsis

bool
bson_iter_init_from_data_at_offset (bson_iter_t *iter,
                                    const uint8_t *data,
                                    size_t length,
                                    uint32_t offset,
                                    uint32_t keylen);

Parameters

Description

Creates a bson_iter_t and starts iteration on a field at the offset.

bson_iter_init_from_data_at_offset is useful for situations where the progress of a bson_iter_t must be saved and restored without relying on the bson_iter_t data layout. Saving the progress could be accomplished by:

Then later, these saved values can be passed to bson_iter_init_from_data_at_offset() to reconstruct the bson_iter_t in constant time.

See Also

Returns

Returns true if the iter was successfully initialized.

Author

MongoDB, Inc

Info

Nov 06, 2019 1.15.2 Libbson