| Top | |
|
|
|
| JsonGenerator * | json_generator_new () |
| void | json_generator_set_root () |
| JsonNode * | json_generator_get_root () |
| void | json_generator_set_pretty () |
| gboolean | json_generator_get_pretty () |
| void | json_generator_set_indent () |
| guint | json_generator_get_indent () |
| void | json_generator_set_indent_char () |
| gunichar | json_generator_get_indent_char () |
| gboolean | json_generator_to_file () |
| gchar * | json_generator_to_data () |
| gboolean | json_generator_to_stream () |
| guint | indent | Read / Write |
| guint | indent-char | Read / Write |
| gboolean | pretty | Read / Write |
| JsonNode * | root | Read / Write |
JsonGenerator provides an object for generating a JSON data stream and put it into a buffer or a file.
JsonGenerator *
json_generator_new (void);
Creates a new JsonGenerator. You can use this object to generate a JSON data stream starting from a data object model composed by JsonNodes.
void json_generator_set_root (JsonGenerator *generator,JsonNode *node);
Sets node
as the root of the JSON data stream to be serialized by
the JsonGenerator.
JsonNode *
json_generator_get_root (JsonGenerator *generator);
Retrieves a pointer to the root JsonNode set using
json_generator_set_root().
a JsonNode, or NULL. The returned node
is owned by the JsonGenerator and it should not be freed.
[transfer none]
Since 0.14
void json_generator_set_pretty (JsonGenerator *generator,gboolean is_pretty);
Sets whether the generated JSON should be pretty printed, using the indentation character specified in the “indent-char” property and the spacing specified in “indent” property.
Since 0.14
gboolean
json_generator_get_pretty (JsonGenerator *generator);
Retrieves the value set using json_generator_set_pretty().
Since 0.14
void json_generator_set_indent (JsonGenerator *generator,guint indent_level);
Sets the number of repetitions for each indentation level.
generator |
||
indent_level |
the number of repetitions of the indentation character that should be applied when pretty printing |
Since 0.14
guint
json_generator_get_indent (JsonGenerator *generator);
Retrieves the value set using json_generator_set_indent().
Since 0.14
void json_generator_set_indent_char (JsonGenerator *generator,gunichar indent_char);
Sets the character to be used when indenting
Since 0.14
gunichar
json_generator_get_indent_char (JsonGenerator *generator);
Retrieves the value set using json_generator_set_indent_char().
Since 0.14
gboolean json_generator_to_file (JsonGenerator *generator,const gchar *filename,GError **error);
Creates a JSON data stream and puts it inside filename
, overwriting the
current file contents. This operation is atomic.
gchar * json_generator_to_data (JsonGenerator *generator,gsize *length);
Generates a JSON data stream from generator
and returns it as a
buffer.
gboolean json_generator_to_stream (JsonGenerator *generator,GOutputStream *stream,GCancellable *cancellable,GError **error);
Outputs JSON data and streams it (synchronously) to stream
.
generator |
||
stream |
a GOutputStream |
|
cancellable |
a GCancellable, or |
[allow-none] |
error |
return location for a GError, or |
TRUE if the write operation was successful, and FALSE
on failure. In case of error, the GError will be filled accordingly
Since 0.12
struct JsonGenerator;
JSON data streams generator. The contents of the JsonGenerator structure are private and should only be accessed via the provided API.
“indent” property “indent” guint
Number of spaces to be used to indent when pretty printing.
Flags: Read / Write
Default value: 2
“indent-char” property “indent-char” guint
The character that should be used when indenting in pretty print.
Flags: Read / Write
Default value: ' '
Since 0.6
“pretty” property “pretty” gboolean
Whether the output should be "pretty-printed", with indentation and newlines. The indentation level can be controlled by using the JsonGenerator:indent property
Flags: Read / Write
Default value: FALSE