FreeBSD Manual Pages
BSON_ITER_UTF8(3) libbson BSON_ITER_UTF8(3) SYNOPSIS #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); PARAMETERS • iter: A bson_iter_t. • length: An optional location for the length of the resulting UTF-8 encoded string. DESCRIPTION The bson_iter_utf8() 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. RETURNS 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 be- fore using this in other places. That can be done by calling bson_utf8_validate() or validating the underlying bson_t before iterat- ing 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. AUTHOR MongoDB, Inc COPYRIGHT 2009-present, MongoDB, Inc. 1.30.2 Apr 12, 2025 BSON_ITER_UTF8(3)
SYNOPSIS | PARAMETERS | DESCRIPTION | RETURNS | AUTHOR | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bson_iter_utf8&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>