Difference between revisions of "Textutils.unserialize"

Latest revision as of 21:17, 16 February 2015

Function textutils.unserialize
Returns the data reassembled from string `serializedData`. Returns nil if unable to unserialize. Used mainly together with textutils.serialize(). Also exists as textutils.unserialise under CC 1.6 or later. Note: the representation used by textutils.serialize() actually creates Lua-friendly syntax, so that loadstring() will also work to unserialize. See textutils.serialize() for more information.
Syntax	textutils.unserialize(string serializedData)
Returns	any unserializedData
Part of	ComputerCraft
API	textutils

Example
Unserializes a table and prints a value in it.
Code	local serializedTable = "{value=2}" local myTable = textutils.unserialize( serializedTable ) print( myTable.value )
Output	2

@@ Line 2: / Line 2: @@
 {{Function
 |name=textutils.unserialize
-|args= [[string (type)|string]]
+|args={{type|string}} serializedData
-|returns=a copy of the original object which was serialized
+|returns={{type|any}} unserializedData
 |api=textutils
 |addon=ComputerCraft
-|desc=Converts a serialized string back into an object.  The string should have been created using [[Textutils.serialize|textutils.serialize]]().   Note, the representation used by [[Textutils_(API)|textutils]] actually creates Lua-friendly syntax, so that loadstring() will also work to unserialize. See [[textutils.serialize]]() for more information.
+|desc=Returns the data reassembled from string <var>serializedData</var>. Returns {{type|nil}} if unable to unserialize. Used mainly together with [[textutils.serialize]](). Also exists as textutils.unseriali'''s'''e under CC 1.6 or later.
+<br/>
+Note: the representation used by [[textutils.serialize]]() actually creates Lua-friendly syntax, so that [[loadstring]]() will also work to unserialize. See [[textutils.serialize]]() for more information.
+|examples=
+{{Example
+|desc=Unserializes a table and prints a value in it.
+|code=local serializedTable = "{value=2}"
+ local myTable = '''textutils.unserialize( serializedTable )'''
+ [[print]]( myTable.value )
+|output=2
+}}
 }}
 [[Category:API_Functions]]