Difference between revisions of "Textutils.serialize"
From ComputerCraft Wiki
m (Moved to CAT:APIFunctions) |
m (Fix bug in code example) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 2: | Line 2: | ||
{{Function | {{Function | ||
|name=textutils.serialize | |name=textutils.serialize | ||
| − | |args= | + | |args={{type|table}}/{{type|string}}/{{type|number}}/{{type|boolean}}/{{type|nil}} data |
| − | |returns= | + | |returns={{type|string}} serializedData |
|api=textutils | |api=textutils | ||
|addon=ComputerCraft | |addon=ComputerCraft | ||
| − | |desc=Converts the object to a string that can be saved in a file or sent over rednet and then converted back into a copy of the object later, using [[textutils. | + | |desc=Converts the object to a string that can be [[fs_(API)|saved in a file]] or sent over [[rednet_(API)|rednet]] and then converted back into a copy of the object later, using [[textutils.unserialize]](). Nested structures are supported, but tables with circular graphs will be detected and raise an error.<br/> |
| + | <br/> | ||
| + | In ComputerCraft 1.6 and up tables are serialized in a readable format: new lines and indention is applied. | ||
|examples= | |examples= | ||
{{Example | {{Example | ||
| − | |desc= | + | |desc=Serializes a table and prints it |
| − | |code= | + | |code=local myTable = { |
| − | + | key = "value", | |
| − | [[ | + | [5] = "numbers", |
| − | + | array = {1, 2, 3} | |
| − | + | } | |
| − | |output= | + | |
| + | [[print]]( '''textutils.serialize( myTable )''' ) | ||
| + | |output= | ||
| + | { | ||
| + | key = "value", | ||
| + | [5] = "numbers", | ||
| + | array = { | ||
| + | 1, | ||
| + | 2, | ||
| + | 3 | ||
| + | } | ||
| + | } | ||
| + | | ||
}} | }} | ||
}} | }} | ||
[[Category:API_Functions]] | [[Category:API_Functions]] | ||
Latest revision as of 14:57, 28 July 2016
 Function textutils.serialize | |
| Converts the object to a string that can be saved in a file or sent over rednet and then converted back into a copy of the object later, using textutils.unserialize(). Nested structures are supported, but tables with circular graphs will be detected and raise an error.
| |
| Syntax | textutils.serialize(table/string/number/boolean/nil data) |
| Returns | string serializedData |
| Part of | ComputerCraft |
| API | textutils |
Examples
 Example | |
| Serializes a table and prints it | |
| Code |
local myTable = {
key = "value",
[5] = "numbers",
array = {1, 2, 3}
}
print( textutils.serialize( myTable ) )
|
| Output |
{
key = "value",
[5] = "numbers",
array = {
1,
2,
3
}
}
|
