carta
bson_as_relaxed_extended_json(3)

bson_as_relaxed_extended_json3

Parameters

•

bson: A bson_t.

•

length: An optional location for the length of the resulting string.

Overview

bson_as_relaxed_extended_json() encodes bson as a UTF-8 string in Relaxed Extended JSON. See MongoDB Extended JSON format for a description of Extended JSON formats.

The caller is responsible for freeing the resulting UTF-8 encoded string by calling bson_free() with the result.

If non-NULL, length will be set to the length of the result in bytes.

Returns

If successful, a newly allocated UTF-8 encoded string and length is set.

Upon failure, NULL is returned.

Examples

bson_t *b = BCON_NEW ("foo", BCON_INT32 (123));
char *str = bson_as_relaxed_extended_json (b, NULL);
printf ("Relaxed Extended JSON: %s\n", str);
// Prints:
// Relaxed Extended JSON: { "foo" : 123 }
bson_free (str);
bson_destroy (b);

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)

Author

MongoDB, Inc

From libbson-doc 1.30.4-1+deb13u3 in Debian 13 (Trixie). Parsed by carta from the page's man source.