JSONSerialization Struct Reference

#include <JSONSerialization.h>

Overview

JSON serialization and introspection.

Definition at line 63 of file JSONSerialization.h.

Inheritance diagram for JSONSerialization:

Properties
Object	object
	The superclass. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_JSONSerialization (void)
	The JSONSerialization archetype. More...
Data *	dataFromObject (const ident obj, int options)
	Serializes the given Object to JSON Data. More...
ident	objectFromData (const Data *data, int options)
	Parses an Object from the specified Data. More...
Methods inherited from Object
Class *	_Object (void)
	The Object archetype. More...
Object *	copy (const Object *self)
	Creates a shallow copy of this Object. More...
void	dealloc (Object *self)
	Frees all resources held by this Object. More...
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object. More...
_Bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object. More...
_Bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership. More...

Protected Attributes
JSONSerializationInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

interface

JSONSerializationInterface* JSONSerialization::interface

protected

The interface.

Definition at line 74 of file JSONSerialization.h.

object

Object JSONSerialization::object

The superclass.

Definition at line 68 of file JSONSerialization.h.

Method Details

_JSONSerialization()

Class * _JSONSerialization

(

void

)

The JSONSerialization archetype.

Returns

The JSONSerialization Class.

Definition at line 511 of file JSONSerialization.c.

                                {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "JSONSerialization",
            .superclass = _Object(),
            .instanceSize = sizeof(JSONSerialization),
            .interfaceOffset = offsetof(JSONSerialization, interface),
            .interfaceSize = sizeof(JSONSerializationInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

dataFromObject()

Data * dataFromObject	(	const ident	obj,
		int	options
	)

Serializes the given Object to JSON Data.

Parameters

obj	The Object to serialize.
options	A bitwise-or of JSON_WRITE_*.

Returns

The resulting JSON Data.

Definition at line 223 of file JSONSerialization.c.

                                                          {
 
    if (obj) {
        JSONWriter writer = {
            .data = $(alloc(MutableData), init),
            .options = options
        };
 
        writeObject(&writer, obj);
 
        return (Data *) writer.data;
    }
 
    return NULL;
}

objectFromData()

ident objectFromData	(	const Data *	data,
		int	options
	)

Parses an Object from the specified Data.

Parameters

data	The JSON Data.
options	A bitwise-or of JSON_READ_*.

Returns

The Object, or NULL on error.

Definition at line 482 of file JSONSerialization.c.

                                                           {
 
    if (data && data->length) {
        JSONReader reader = {
            .data = data,
            .options = options
        };
 
        return readElement(&reader);
    }
 
    return NULL;
}

---

The documentation for this struct was generated from the following files:

• Sources/Objectively/JSONSerialization.h
• Sources/Objectively/JSONSerialization.c