From 9021cdcdd01fc9dbcbe1f06391848c2ac915212f Mon Sep 17 00:00:00 2001 From: Eric Haszlakiewicz Date: Sun, 26 Jul 2020 15:13:45 +0000 Subject: Generate docs for the 0.15 release --- doc/html/json__util_8h.html | 477 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 477 insertions(+) create mode 100644 doc/html/json__util_8h.html (limited to 'doc/html/json__util_8h.html') diff --git a/doc/html/json__util_8h.html b/doc/html/json__util_8h.html new file mode 100644 index 0000000..06fcf4e --- /dev/null +++ b/doc/html/json__util_8h.html @@ -0,0 +1,477 @@ + + + + + +json-c: /home/erh/json-c-0.15/json_util.h File Reference + + + + + + +
+
+ + + + + + +
+
json-c +  0.15 +
+
+
+ + + + + +
+
+
+Macros | +Functions
+
+
json_util.h File Reference
+
+
+ +

Miscllaneous utility functions and macros. +More...

+ + + + + + + + +

+Macros

#define json_min(a, b)   ((a) < (b) ? (a) : (b))
 
#define json_max(a, b)   ((a) > (b) ? (a) : (b))
 
#define JSON_FILE_BUF_SIZE   4096
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Functions

JSON_EXPORT struct json_object * json_object_from_file (const char *filename)
 
JSON_EXPORT struct json_object * json_object_from_fd_ex (int fd, int depth)
 
JSON_EXPORT struct json_object * json_object_from_fd (int fd)
 
JSON_EXPORT int json_object_to_file (const char *filename, struct json_object *obj)
 
JSON_EXPORT int json_object_to_file_ext (const char *filename, struct json_object *obj, int flags)
 
JSON_EXPORT int json_object_to_fd (int fd, struct json_object *obj, int flags)
 
JSON_EXPORT const char * json_util_get_last_err (void)
 
JSON_EXPORT int json_parse_int64 (const char *buf, int64_t *retval)
 
JSON_EXPORT int json_parse_uint64 (const char *buf, uint64_t *retval)
 
JSON_EXPORT int json_parse_double (const char *buf, double *retval)
 
JSON_EXPORT const char * json_type_to_name (enum json_type o_type)
 
+

Detailed Description

+

Miscllaneous utility functions and macros.

+

Macro Definition Documentation

+ +
+
+ + + + +
#define JSON_FILE_BUF_SIZE   4096
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
#define json_max( a,
 b 
)   ((a) > (b) ? (a) : (b))
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
#define json_min( a,
 b 
)   ((a) < (b) ? (a) : (b))
+
+ +
+
+

Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
JSON_EXPORT struct json_object* json_object_from_fd (int fd)
+ 		+read
+
+

Create a JSON object from an already opened file descriptor, using the default maximum object depth. (JSON_TOKENER_DEFAULT_DEPTH)

+

See json_object_from_fd_ex() for details.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
JSON_EXPORT struct json_object* json_object_from_fd_ex (int fd,
int depth 
)
+ 		+read
+
+

Create a JSON object from already opened file descriptor.

+

This function can be helpful, when you opened the file already, e.g. when you have a temp file. Note, that the fd must be readable at the actual position, i.e. use lseek(fd, 0, SEEK_SET) before.

+

The depth argument specifies the maximum object depth to pass to json_tokener_new_ex(). When depth == -1, JSON_TOKENER_DEFAULT_DEPTH is used instead.

+

Returns NULL on failure. See json_util_get_last_err() for details.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
JSON_EXPORT struct json_object* json_object_from_file (const char * filename)
+ 		+read
+
+

Read the full contents of the given file, then convert it to a json_object using json_tokener_parse().

+

Returns NULL on failure. See json_util_get_last_err() for details.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
JSON_EXPORT int json_object_to_fd (int fd,
struct json_object * obj,
int flags 
)
+
+

Convert the json_object to a string and write it to the file descriptor. Handles partial writes and will keep writing until done, or an error occurs.

+
Parameters
+ + + + +
fdan open, writable file descriptor to write to
objthe object to serializer and write
flagsflags to pass to json_object_to_json_string_ext()
+
+
+
Returns
-1 if something fails. See json_util_get_last_err() for details.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
JSON_EXPORT int json_object_to_file (const char * filename,
struct json_object * obj 
)
+
+

Equivalent to: json_object_to_file_ext(filename, obj, JSON_C_TO_STRING_PLAIN);

+

Returns -1 if something fails. See json_util_get_last_err() for details.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
JSON_EXPORT int json_object_to_file_ext (const char * filename,
struct json_object * obj,
int flags 
)
+
+

Open and truncate the given file, creating it if necessary, then convert the json_object to a string and write it to the file.

+

Returns -1 if something fails. See json_util_get_last_err() for details.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
JSON_EXPORT int json_parse_double (const char * buf,
double * retval 
)
+
+
Deprecated:
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
JSON_EXPORT int json_parse_int64 (const char * buf,
int64_t * retval 
)
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
JSON_EXPORT int json_parse_uint64 (const char * buf,
uint64_t * retval 
)
+
+ +
+
+ +
+
+ + + + + + + + +
JSON_EXPORT const char* json_type_to_name (enum json_type o_type)
+
+

Return a string describing the type of the object. e.g. "int", or "object", etc...

+ +
+
+ +
+
+ + + + + + + + +
JSON_EXPORT const char* json_util_get_last_err (void )
+
+

Return the last error from various json-c functions, including: json_object_to_file{,ext}, json_object_to_fd() or json_object_from{file,fd}, or NULL if there is none.

+ +
+
+
+ +
+Generated on Sun Jul 26 2020 15:11:19 for json-c by   +doxygen + 1.8.2 +
+ + -- cgit v1.2.1