bson_iter_overwrite_bool man page

bson_iter_overwrite_bool() — The bson_iter_overwrite_bool() function shall overwrite the contents of a BSON_TYPE_BOOL element in place.

Synopsis

void
bson_iter_overwrite_bool (bson_iter_t *iter,
                          bool         value);

Parameters

iter
A bson_iter_t
value
A bool containing the new value.

Description

The bson_iter_overwrite_bool(3) function shall overwrite the contents of a BSON_TYPE_BOOL element in place.

This may only be done when the underlying bson document allows mutation.

It is a programming error to call this function when iter is not obvserving an element of type BSON_TYPE_BOOL.

Colophon

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Info

2016‐10‐28 libbson