Scroll to navigation

BSON_JSON_OPTS_T(3) libbson BSON_JSON_OPTS_T(3)

BSON to JSON encoding options

SYNOPSIS

#include <bson/bson.h>
typedef struct _bson_json_opts_t bson_json_opts_t;
bson_json_opts_t *
bson_json_opts_new (bson_json_mode_t mode, int32_t max_len);
void
bson_json_opts_destroy (bson_json_opts_t *opts);


DESCRIPTION

The bson_json_opts_t <> structure contains options for encoding BSON into MongoDB Extended JSON <https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md>.

The mode member is a bson_json_mode_t <> defining the encoding mode.

The max_len member holds a maximum length for the resulting JSON string. Encoding will stop once the serialised string has reached this length. To encode the full BSON document, BSON_MAX_LEN_UNLIMITED can be used.

See also:

bson_as_json_with_opts() <>



Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

December 11, 2025 2.2.1