Simple JSON string builder utility. More...

#include <cwist/core/sstring/sstring.h>
#include <stdbool.h>

Include dependency graph for json_builder.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	cwist_json_builder
	Simple JSON string builder utility. More...

Typedefs
typedef struct cwist_json_builder	cwist_json_builder
	Simple JSON string builder utility.

Functions
cwist_json_builder *	cwist_json_builder_create (void)
	Create a new JSON builder.

void	cwist_json_builder_destroy (cwist_json_builder *b)
	Destroy a JSON builder.

void	cwist_json_begin_object (cwist_json_builder *b)
	Begin a JSON object.

void	cwist_json_end_object (cwist_json_builder *b)
	End a JSON object.

void	cwist_json_begin_array (cwist_json_builder b, const char key)
	Begin a JSON array.

void	cwist_json_end_array (cwist_json_builder *b)
	End a JSON array.

void	cwist_json_add_string (cwist_json_builder b, const char key, const char *value)
	Add a string value.

void	cwist_json_add_int (cwist_json_builder b, const char key, int value)
	Add an integer value.

void	cwist_json_add_bool (cwist_json_builder b, const char key, bool value)
	Add a boolean value.

void	cwist_json_add_null (cwist_json_builder b, const char key)
	Add a null value.

const char *	cwist_json_get_raw (cwist_json_builder *b)
	Returns the raw string buffer. Invalidated on destroy.

Detailed Description

Simple JSON string builder utility.

Definition in file json_builder.h.

Typedef Documentation

◆ cwist_json_builder

typedef struct cwist_json_builder cwist_json_builder

Simple JSON string builder utility.

Usage:

cwist_json_builder *jb = cwist_json_builder_create();
cwist_json_begin_object(jb);
cwist_json_add_string(jb, "message", "Hello");
cwist_json_add_int(jb, "code", 200);
cwist_json_end_object(jb);
char *json = cwist_json_build(jb);
cwist_sstring *res = cwist_json_get_string(jb);
cwist_json_builder_destroy(jb);

Function Documentation

◆ cwist_json_add_bool()

void cwist_json_add_bool	(	cwist_json_builder *	b,
		const char *	key,
		bool	value
	)

Add a boolean value.

Parameters

b	Builder to update. NULL is ignored.
key	Object member name, or NULL when appending an array element.
value	Boolean payload to serialise as true or false.

Definition at line 226 of file json_builder.c.

References cwist_json_builder::buffer, cwist_sstring_append(), and cwist_json_builder::needs_comma.

Referenced by cwist_bind_write_error_response().

◆ cwist_json_add_int()

void cwist_json_add_int	(	cwist_json_builder *	b,
		const char *	key,
		int	value
	)

Add an integer value.

Parameters

b	Builder to update. NULL is ignored.
key	Object member name, or NULL when appending an array element.
value	Integer payload to format in base 10.

Definition at line 210 of file json_builder.c.

References cwist_json_builder::buffer, cap, cwist_sstring_append(), and cwist_json_builder::needs_comma.

◆ cwist_json_add_null()

void cwist_json_add_null	(	cwist_json_builder *	b,
		const char *	key
	)

Add a null value.

Parameters

b	Builder to update. NULL is ignored.
key	Object member name, or NULL when appending an array element.

Definition at line 239 of file json_builder.c.

References cwist_json_builder::buffer, cwist_sstring_append(), and cwist_json_builder::needs_comma.

◆ cwist_json_add_string()

void cwist_json_add_string	(	cwist_json_builder *	b,
		const char *	key,
		const char *	value
	)

Add a string value.

Parameters

b	Builder to update. NULL is ignored.
key	Object member name, or NULL when appending an array element.
value	String payload to emit verbatim between quotes.

Definition at line 192 of file json_builder.c.

References cwist_json_builder::buffer, cwist_sstring_append(), and cwist_json_builder::needs_comma.

Referenced by cwist_app_healthz(), and cwist_bind_write_error_response().