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

document new null-friendly functions

Browse Source
This commit is contained in:
Chip Salzenberg 2013-09-27 19:10:32 -07:00
parent face43929d
commit 0be5c959da
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/apiref.rst
View File

@ -304,6 +304,13 @@ U+10FFFF are allowed.
Returns a new JSON string, or *NULL* on error. *value* must be a Returns a new JSON string, or *NULL* on error. *value* must be a
valid UTF-8 encoded Unicode string. valid UTF-8 encoded Unicode string.
.. function:: json_t *json_stringn(const char *value, size_t len)
.. refcounting:: new
Like :func:`json_string`, but with explicit length, so *value* may
contain null characters or not be null terminated.
.. function:: json_t *json_string_nocheck(const char *value) .. function:: json_t *json_string_nocheck(const char *value)
.. refcounting:: new .. refcounting:: new
@ -312,6 +319,13 @@ U+10FFFF are allowed.
UTF-8. Use this function only if you are certain that this really UTF-8. Use this function only if you are certain that this really
is the case (e.g. you have already checked it by other means). is the case (e.g. you have already checked it by other means).
.. function:: json_t *json_stringn_nocheck(const char *value, size_t len)
.. refcounting:: new
Like :func:`json_string_nocheck`, but with explicit length, so
*value* may contain null characters or not be null terminated.
.. 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
@ -321,12 +335,22 @@ U+10FFFF are allowed.
the user. It is valid as long as *string* exists, i.e. as long as the user. It is valid as long as *string* exists, i.e. as long as
its reference count has not dropped to zero. its reference count has not dropped to zero.
.. function:: size_t json_string_length(const json_t *string)
Returns the length of *string* as a UTF-8 encoded string, or zero
if *string* is not a JSON string.
.. function:: int json_string_set(const json_t *string, const char *value) .. function:: int json_string_set(const 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
valid UTF-8 encoded Unicode string. Returns 0 on success and -1 on valid UTF-8 encoded Unicode string. Returns 0 on success and -1 on
error. error.
.. function:: int json_string_setn(json_t *string, const char *value, size_t len)
Like :func:`json_string_set`, but with explicit length, so *value*
may contain null characters or not be null terminated.
.. function:: int json_string_set_nocheck(const json_t *string, const char *value) .. function:: int json_string_set_nocheck(const 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
@ -334,6 +358,11 @@ U+10FFFF are allowed.
really is the case (e.g. you have already checked it by other really is the case (e.g. you have already checked it by other
means). means).
.. function:: int json_string_setn_nocheck(json_t *string, const char *value, size_t len)
Like :func:`json_string_set_nocheck`, but with explicit length,
so *value* may contain null characters or not be null terminated.
Number Number
====== ======