Scroll to navigation

BSON_UTF8_ESCAPE_FOR_JSON(3) libbson BSON_UTF8_ESCAPE_FOR_JSON(3)

SYNOPSIS

char *
bson_utf8_escape_for_json (const char *utf8, ssize_t utf8_len);


PARAMETERS

  • utf8: A UTF-8 encoded string.
  • utf8_len: The length of utf8 in bytes or -1 if it is NULL terminated.

DESCRIPTION

Allocates a new string matching utf8 except that special characters in JSON are escaped. The resulting string is also UTF-8 encoded.

Both " and \ characters will be backslash-escaped. If a NUL byte is found before utf8_len bytes, it is converted to "\u0000". Other non-ASCII characters in the input are preserved.

RETURNS

A newly allocated string that should be freed with bson_free() when utf8 is a valid UTF-8 string, or NULL if the (possibly invalid UTF-8) string could not be escaped.

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.

October 9, 2024 1.28.1