FreeBSD Manual Pages
BSON_VALIDATE(3) libbson BSON_VALIDATE(3) SYNOPSIS bool bson_validate (const bson_t *bson, bson_validate_flags_t flags, size_t *offset); PARAMETERS • bson: A bson_t. • flags: A bitwise-or of all desired bson_validate_flags_t. • offset: Optional location where the error offset will be written. DESCRIPTION Validates a BSON document by walking through the document and inspect- ing 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, re- turns false and if offset is non-NULL it will be written with the byte offset in the document where an error was detected. To get more information about the specific validation failure, use bson_validate_with_error_and_offset() instead. SEE ALSO: bson_validate_with_error(), bson_validate_with_error_and_offset(). bson_visitor_t can be used for custom validation, Example Custom Validation. AUTHOR MongoDB, Inc COPYRIGHT 2009-present, MongoDB, Inc. 1.30.2 Apr 12, 2025 BSON_VALIDATE(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_validate&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>