Features

Limitations

Performance

AWS EC2 (AMD EPYC 7R32, gcc 9.3)

iPhone (Apple A14, clang 12)

For better performance, yyjson prefers:

Sample Code

Read JSON string

constchar*json="{\"name\":\"Mash\",\"star\":4,\"hits\":[2,2,1,3]}";// Read JSON and get rootyyjson_doc*doc=yyjson_read(json,strlen(json),0);yyjson_val*root=yyjson_doc_get_root(doc);// Get root["name"]yyjson_val*name=yyjson_obj_get(root,"name");printf("name: %s\n",yyjson_get_str(name));printf("name length:%d\n", (int)yyjson_get_len(name));// Get root["star"]yyjson_val*star=yyjson_obj_get(root,"star");printf("star: %d\n", (int)yyjson_get_int(star));// Get root["hits"], iterate over the arrayyyjson_val*hits=yyjson_obj_get(root,"hits");size_tidx,max;yyjson_val*hit;yyjson_arr_foreach(hits,idx,max,hit) {printf("hit%d: %d\n", (int)idx, (int)yyjson_get_int(hit));}// Free the docyyjson_doc_free(doc);// All functions accept NULL input, and return NULL on error.

Write JSON string

// Create a mutable docyyjson_mut_doc*doc=yyjson_mut_doc_new(NULL);yyjson_mut_val*root=yyjson_mut_obj(doc);yyjson_mut_doc_set_root(doc,root);// Set root["name"] and root["star"]yyjson_mut_obj_add_str(doc,root,"name","Mash");yyjson_mut_obj_add_int(doc,root,"star",4);// Set root["hits"] with an arrayinthits_arr[]= {2,2,1,3};yyjson_mut_val*hits=yyjson_mut_arr_with_sint32(doc,hits_arr,4);yyjson_mut_obj_add_val(doc,root,"hits",hits);// To string, minifiedconstchar*json=yyjson_mut_write(doc,0,NULL);if (json) {printf("json: %s\n",json);// {"name":"Mash","star":4,"hits":[2,2,1,3]}free((void*)json);}// Free the docyyjson_mut_doc_free(doc);

Read JSON file with options

// Read JSON file, allowing comments and trailing commasyyjson_read_flagflg=YYJSON_READ_ALLOW_COMMENTS |YYJSON_READ_ALLOW_TRAILING_COMMAS;yyjson_read_errerr;yyjson_doc*doc=yyjson_read_file("/tmp/config.json",flg,NULL,&err);// Iterate over the root objectif (doc) {yyjson_val*obj=yyjson_doc_get_root(doc);yyjson_obj_iteriter;yyjson_obj_iter_init(obj,&iter);yyjson_val*key,*val;while ((key=yyjson_obj_iter_next(&iter))) {val=yyjson_obj_iter_get_val(key);printf("%s: %s\n",yyjson_get_str(key),yyjson_get_type_desc(val));    }}else {printf("read error (%u): %s at position: %ld\n",err.code,err.msg,err.pos);}// Free the docyyjson_doc_free(doc);

Write JSON file with options

// Read the JSON file as a mutable docyyjson_doc*idoc=yyjson_read_file("/tmp/config.json",0,NULL,NULL);yyjson_mut_doc*doc=yyjson_doc_mut_copy(idoc,NULL);yyjson_mut_val*obj=yyjson_mut_doc_get_root(doc);// Remove null values in root objectyyjson_mut_obj_iteriter;yyjson_mut_obj_iter_init(obj,&iter);yyjson_mut_val*key,*val;while ((key=yyjson_mut_obj_iter_next(&iter))) {val=yyjson_mut_obj_iter_get_val(key);if (yyjson_mut_is_null(val)) {yyjson_mut_obj_iter_remove(&iter);    }}// Write the json pretty, escape unicodeyyjson_write_flagflg=YYJSON_WRITE_PRETTY |YYJSON_WRITE_ESCAPE_UNICODE;yyjson_write_errerr;yyjson_mut_write_file("/tmp/config.json",doc,flg,NULL,&err);if (err.code) {printf("write error (%u): %s\n",err.code,err.msg);}// Free the docyyjson_doc_free(idoc);yyjson_mut_doc_free(doc);

Documentation

Packaging status

Built With yyjson

TODO for v1.0

License