fl_json_message_codec.h File Reference

#include <gmodule.h>
#include "fl_message_codec.h"

Go to the source code of this file.

Macros
#define	FL_JSON_MESSAGE_CODEC_ERROR   fl_json_message_codec_error_quark()

Enumerations
enum	FlJsonMessageCodecError {   FL_JSON_MESSAGE_CODEC_ERROR_INVALID_UTF8,   FL_JSON_MESSAGE_CODEC_ERROR_INVALID_JSON,   FL_JSON_MESSAGE_CODEC_ERROR_INVALID_OBJECT_KEY_TYPE }

Functions
G_MODULE_EXPORT GQuark	fl_json_message_codec_error_quark (void) G_GNUC_CONST
G_MODULE_EXPORT	G_DECLARE_FINAL_TYPE (FlJsonMessageCodec, fl_json_message_codec, FL, JSON_CODEC, FlMessageCodec) FlJsonMessageCodec *fl_json_message_codec_new()
gchar *	fl_json_message_codec_encode (FlJsonMessageCodec *codec, FlValue *value, GError **error)
FlValue *	fl_json_message_codec_decode (FlJsonMessageCodec *codec, const gchar *text, GError **error)

Macro Definition Documentation

FL_JSON_MESSAGE_CODEC_ERROR

#define FL_JSON_MESSAGE_CODEC_ERROR   fl_json_message_codec_error_quark()

FlJsonMessageCodecError: @FL_JSON_MESSAGE_CODEC_ERROR_INVALID_UTF8: Message is not valid UTF-8. @FL_JSON_MESSAGE_CODEC_ERROR_INVALID_JSON: Message is not valid JSON. @FL_JSON_MESSAGE_CODEC_ERROR_INVALID_OBJECT_KEY_TYPE: Invalid object key type.

Errors for #FlJsonMessageCodec objects to set on failures.

Definition at line 27 of file fl_json_message_codec.h.

Enumeration Type Documentation

FlJsonMessageCodecError

enum FlJsonMessageCodecError

Enumerator
FL_JSON_MESSAGE_CODEC_ERROR_INVALID_UTF8
FL_JSON_MESSAGE_CODEC_ERROR_INVALID_JSON
FL_JSON_MESSAGE_CODEC_ERROR_INVALID_OBJECT_KEY_TYPE

Definition at line 29 of file fl_json_message_codec.h.

             {
  // NOLINTBEGIN(readability-identifier-naming)
  FL_JSON_MESSAGE_CODEC_ERROR_INVALID_UTF8,
  FL_JSON_MESSAGE_CODEC_ERROR_INVALID_JSON,
  FL_JSON_MESSAGE_CODEC_ERROR_INVALID_OBJECT_KEY_TYPE,
  // NOLINTEND(readability-identifier-naming)
} FlJsonMessageCodecError;

Function Documentation

fl_json_message_codec_decode()

FlValue* fl_json_message_codec_decode	(	FlJsonMessageCodec *	codec,
		const gchar *	text,
		GError **	error
	)

fl_json_message_codec_decode: @codec: an #FlJsonMessageCodec. @text: UTF-8 text in JSON format. @error: (allow-none): #GError location to store the error occurring, or NULL.

Decodes a value from a JSON string.

Returns: an FlValue or NULL on error.

Definition at line 326 of file fl_json_message_codec.cc.

                                                                      {
  g_return_val_if_fail(FL_IS_JSON_CODEC(codec), nullptr);
 
  g_autoptr(GBytes) data = g_bytes_new_static(text, strlen(text));
  g_autoptr(FlValue) value = fl_json_message_codec_decode_message(
      FL_MESSAGE_CODEC(codec), data, error);
  if (value == nullptr) {
    return nullptr;
  }
 
  return fl_value_ref(value);
}

References error, fl_json_message_codec_decode_message(), fl_value_ref(), and value.

Referenced by decode_error_message(), decode_message(), and TEST().

fl_json_message_codec_encode()

gchar* fl_json_message_codec_encode	(	FlJsonMessageCodec *	codec,
		FlValue *	value,
		GError **	error
	)

fl_json_message_codec_encode: @codec: an #FlJsonMessageCodec. @value: value to encode. @error: (allow-none): #GError location to store the error occurring, or NULL.

Encodes a value to a JSON string.

Returns: a JSON representation of this value or NULL on error.

Definition at line 311 of file fl_json_message_codec.cc.

                                                                    {
  g_return_val_if_fail(FL_IS_JSON_CODEC(codec), nullptr);
 
  rapidjson::StringBuffer buffer;
  rapidjson::Writer<rapidjson::StringBuffer> writer(buffer);
 
  if (!write_value(writer, value, error)) {
    return nullptr;
  }
 
  return g_strdup(buffer.GetString());
}

References buffer, error, and value.

Referenced by encode_error_message(), encode_message(), and TEST().

fl_json_message_codec_error_quark()

G_MODULE_EXPORT GQuark fl_json_message_codec_error_quark

(

void

)

G_DECLARE_FINAL_TYPE()

G_MODULE_EXPORT G_DECLARE_FINAL_TYPE	(	FlJsonMessageCodec	,
		fl_json_message_codec	,
		FL	,
		JSON_CODEC	,
		FlMessageCodec
	)

FlJsonMessageCodec:

#FlJsonMessageCodec is an #FlMessageCodec that implements the encodes FlValue to/from JSON. This codec encodes and decodes FlValue of type FL_VALUE_TYPE_NULL, FL_VALUE_TYPE_BOOL, FL_VALUE_TYPE_INT, FL_VALUE_TYPE_FLOAT, FL_VALUE_TYPE_STRING, FL_VALUE_TYPE_UINT8_LIST, FL_VALUE_TYPE_INT32_LIST, FL_VALUE_TYPE_INT64_LIST, FL_VALUE_TYPE_FLOAT_LIST, FL_VALUE_TYPE_LIST, and FL_VALUE_TYPE_MAP.

#FlJsonMessageCodec matches the JSONMessageCodec class in the Flutter services library. fl_json_message_codec_new:

Creates an #FlJsonMessageCodec.

Returns: a new #FlJsonMessageCodec.