1BSON_VALIDATE(3)                    libbson                   BSON_VALIDATE(3)
2
3
4

SYNOPSIS

6          bool
7          bson_validate (const bson_t *bson, bson_validate_flags_t flags, size_t *offset);
8

PARAMETERS

10       • bson: A bson_t.
11
12       • flags: A bitwise-or of all desired bson_validate_flags_t.
13
14       • offset:  A  location  for  the offset within bson where the error oc‐
15         curred.
16

DESCRIPTION

18       Validates a BSON document by walking through the document and  inspect‐
19       ing the keys and values for valid content.
20
21       You  can  modify how the validation occurs through the use of the flags
22       parameter, see bson_validate_with_error() for details.
23

RETURNS

25       Returns true if bson is valid; otherwise false and offset is set to the
26       byte offset where the error was detected.
27
28       SEE ALSO:
29          bson_validate_with_error().
30
31          bson_visitor_t can be used for custom validation, Example Custom Validation.
32
33

AUTHOR

35       MongoDB, Inc
36

38       2017-present, MongoDB, Inc
39
40
41
42
431.25.1                           Nov 08, 2023                 BSON_VALIDATE(3)
Impressum