bson_iter_utf8 (3) - Linux Man Pages
bson_iter_utf8: The bson_iter_utf8() function shall retrieve the contents of a BSON_TYPE_UTF8 element currently observed by iter.
NAMEbson_iter_utf8() - The bson_iter_utf8() function shall retrieve the contents of a BSON_TYPE_UTF8 element currently observed by iter.
#define BSON_ITER_HOLDS_UTF8(iter) \ (bson_iter_type ((iter)) == BSON_TYPE_UTF8) const char * bson_iter_utf8 (const bson_iter_t *iter, uint32_t *length);
- A bson_iter_t \&.
- An optional location for the length of the resulting UTF-8 encoded string.
The bson_iter_utf8(3) function shall retrieve the contents of a BSON_TYPE_UTF8 element currently observed by iter \&.
It is invalid to call this function while observing an element other than BSON_TYPE_UTF8.
A UTF-8 encoded string that has not been modified or freed.
It is suggested that the caller validate the content is valid UTF-8 before using this in other places. That can be done by calling bson_utf8_validate(3) or validating the underlying bson_t before iterating it.
Note that not all drivers use multi-byte representation for \0 in UTF-8 encodings (commonly referred to as modified-UTF8). You probably want to take a look at the length field when marshaling to other runtimes.
COLOPHONThis page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
Linux man pages generated by: SysTutorials