plucky (3) bson_validate_with_error.3.gz

Provided by: libbson-doc_1.30.0-1_all bug

SYNOPSIS
          bool
          bson_validate_with_error (const bson_t *bson,
                                    bson_validate_flags_t flags,
                                    bson_error_t *error);


PARAMETERS
       • bson: A bson_t.

       • flags: A bitwise-or of all desired bson_validate_flags_t.

       • error: Optional bson_error_t.


DESCRIPTION
       Validates  a  BSON  document by walking through the document and inspecting the keys and values for valid
       content.

       You  can  modify  how  the  validation  occurs  through   the   use   of   the   flags   parameter,   see
       bson_validate_flags_t for details.


RETURNS
       If  bson  passes  the  requested  validations,  returns  true.   Otherwise, returns false and if error is
       non-NULL it will be filled out with details.

       The bson_error_t domain is set to BSON_ERROR_INVALID. Its code is set to one of the bson_validate_flags_t
       flags  indicating which validation failed; for example, if a key contains invalid UTF-8, then the code is
       set to BSON_VALIDATE_UTF8, but if the basic structure of the BSON document is corrupt, the code is set to
       BSON_VALIDATE_NONE. The error message is filled out, and gives more detail if possible.

       To get the specific location of the error, use bson_validate_with_error_and_offset() instead.

       SEE ALSO:
          bson_validate(), bson_validate_with_error_and_offset().

          bson_visitor_t can be used for custom validation, Example Custom Validation.


AUTHOR
       MongoDB, Inc


       2009-present, MongoDB, Inc.