1BSON_ITER_UTF8(3)                   libbson                  BSON_ITER_UTF8(3)
2
3
4

NAME

6       bson_iter_utf8 - bson_iter_utf8()
7

SYNOPSIS

9          #define BSON_ITER_HOLDS_UTF8(iter) (bson_iter_type ((iter)) == BSON_TYPE_UTF8)
10
11          const char *
12          bson_iter_utf8 (const bson_iter_t *iter, uint32_t *length);
13

PARAMETERS

15       • iter: A bson_iter_t.
16
17       • length:  An  optional  location for the length of the resulting UTF-8
18         encoded string.
19

DESCRIPTION

21       The  bson_iter_utf8()  function  shall  retrieve  the  contents  of   a
22       BSON_TYPE_UTF8 element currently observed by iter.
23
24       It  is  invalid  to call this function while observing an element other
25       than BSON_TYPE_UTF8.
26

RETURNS

28       A UTF-8 encoded string that has not been modified or freed.
29
30       It is suggested that the caller validate the content is valid UTF-8 be‐
31       fore  using  this  in  other  places.  That  can  be  done  by  calling
32       bson_utf8_validate() or validating the underlying bson_t before iterat‐
33       ing it.
34
35       Note that not all drivers use multi-byte representation for \0 in UTF-8
36       encodings (commonly referred to as modified-UTF8). You probably want to
37       take a look at the length field when marshaling to other runtimes.
38

AUTHOR

40       MongoDB, Inc
41

43       2017-present, MongoDB, Inc
44
45
46
47
481.24.3                           Aug 17, 2023                BSON_ITER_UTF8(3)
Impressum