FGCOM/jansson
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #378 from phst/doc

Browse Source 
Document that length-aware string functions have been added in 2.7
This commit is contained in:
Petri Lehtinen 2017-12-13 07:05:15 +02:00 committed by GitHub
commit 217859f849
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/apiref.rst
View File

@ -332,6 +332,8 @@ length-aware functions if you wish to embed null bytes in strings.
Like :func:`json_string`, but with explicit length, so *value* may Like :func:`json_string`, but with explicit length, so *value* may
contain null characters or not be null terminated. contain null characters or not be null terminated.
.. versionadded:: 2.7
.. function:: json_t *json_string_nocheck(const char *value) .. function:: json_t *json_string_nocheck(const char *value)
.. refcounting:: new .. refcounting:: new
@ -347,6 +349,8 @@ length-aware functions if you wish to embed null bytes in strings.
Like :func:`json_string_nocheck`, but with explicit length, so Like :func:`json_string_nocheck`, but with explicit length, so
*value* may contain null characters or not be null terminated. *value* may contain null characters or not be null terminated.
.. versionadded:: 2.7
.. function:: const char *json_string_value(const json_t *string) .. function:: const char *json_string_value(const json_t *string)
Returns the associated value of *string* as a null terminated UTF-8 Returns the associated value of *string* as a null terminated UTF-8
@ -361,6 +365,8 @@ length-aware functions if you wish to embed null bytes in strings.
Returns the length of *string* in its UTF-8 presentation, or zero Returns the length of *string* in its UTF-8 presentation, or zero
if *string* is not a JSON string. if *string* is not a JSON string.
.. versionadded:: 2.7
.. function:: int json_string_set(json_t *string, const char *value) .. function:: int json_string_set(json_t *string, const char *value)
Sets the associated value of *string* to *value*. *value* must be a Sets the associated value of *string* to *value*. *value* must be a
@ -372,6 +378,8 @@ length-aware functions if you wish to embed null bytes in strings.
Like :func:`json_string_set`, but with explicit length, so *value* Like :func:`json_string_set`, but with explicit length, so *value*
may contain null characters or not be null terminated. may contain null characters or not be null terminated.
.. versionadded:: 2.7
.. function:: int json_string_set_nocheck(json_t *string, const char *value) .. function:: int json_string_set_nocheck(json_t *string, const char *value)
Like :func:`json_string_set`, but doesn't check that *value* is Like :func:`json_string_set`, but doesn't check that *value* is
@ -384,6 +392,8 @@ length-aware functions if you wish to embed null bytes in strings.
Like :func:`json_string_set_nocheck`, but with explicit length, Like :func:`json_string_set_nocheck`, but with explicit length,
so *value* may contain null characters or not be null terminated. so *value* may contain null characters or not be null terminated.
.. versionadded:: 2.7
Number Number
====== ======