Transformer Pipeline Module API Reference  6.2.11.309924
Serialisation routines

Functions

 serialisation.serialise (var obj, var includeFunctions)
 Serialise an instance of any type of object to a string representation. More...
 
 serialisation.deserialise (var s)
 Deserialise a string into an object representation. More...
 

Detailed Description

The serialisation package allows various object types to be converted to a string and back again.

In order to serialise an object type (i.e. a table with an associated metatable) then object type must be set in member __serialid prior to serialisation.

Function Documentation

serialisation.deserialise ( var  s)

Deserialise a string into an object representation.

Parameters
s- the (serialised) string representation of the object
Returns
the instance of the object
Note
serialisation.serialise ( var  obj,
var  includeFunctions 
)

Serialise an instance of any type of object to a string representation.

Parameters
obj- the instance of the object
includeFunctions- whether functions should be serialised as well
Returns
the string representation of the object
Note

Generated on Sat Aug 26 2017 12:36:33 for Transformer Pipeline Module API Reference