d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

json/json.h: add note on JSON objects and arrays

Browse Source 
Adds a note for JSON objects and arrays inside struct spdk_json_val.

Additionally deletes double space in section about len field.

Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com>
Change-Id: I5d52b37a7e8023df09e16cbf9805bd6775abc5c8
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/8529
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Krzysztof Karas 2021-06-25 14:34:11 +02:00 committed by Tomasz Zawadzki
parent 09c0c9764a
commit f30f862a60
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/spdk/json.h
View File

@ -69,6 +69,9 @@ struct spdk_json_val {
*
* For SPDK_JSON_VAL_NUMBER, this points to the beginning of the number as represented in
* the original JSON (text representation, not converted to a numeric value).
*
* For JSON objects and arrays, this points to their beginning and has a type
* set to SPDK_JSON_VAL_OBJECT_BEGIN or SPDK_JSON_VAL_ARRAY_BEGIN respectively.
*/
void *start;
@ -80,7 +83,7 @@ struct spdk_json_val {
*
* For SPDK_JSON_VAL_ARRAY_BEGIN and SPDK_JSON_VAL_OBJECT_BEGIN,
* this is the number of values contained within the array or object (including
* nested objects and arrays, but not including the _END value). The array or object _END
* nested objects and arrays, but not including the _END value). The array or object _END
* value can be found by advancing len values from the _BEGIN value.
*/
uint32_t len;