77 lines
10 KiB
HTML
77 lines
10 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><!-- use theme color or fallback -->
|
|
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
|
|
<head><meta charset="utf-8"/><link href="../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../jquery-1.9.1.min.js"></script><script src="../bootstrap/js/bootstrap.min.js"></script><script src="../bootstrap/js/bootstrap-select.min.js"></script><link href="../styles.css" rel="stylesheet"/><link href="../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../nav.js"></script><script type="text/javascript" src="../index.js"></script><link rel="icon" href="../favicon.ico" type="image/x-icon"></link><title>haxe.Serializer - API Reference</title><meta name="description" content="The Serializer class can be used to encode values and objects into a <code><a href="../String.html">String</a></code>,
|
|
from which the <code><a href="../haxe/Unserializer.html">Unserializer</a></code> class can recreate the original representation."/></head><body><style>
|
|
a, code .type {
|
|
color: #24afc4;
|
|
}
|
|
.navbar .brand {
|
|
display: inline-block;
|
|
float: none;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
|
|
background: #24afc4;
|
|
color: #ffffff;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
.navbar .container {
|
|
width: 940px ;
|
|
}
|
|
@media (max-width: 767px) {
|
|
.navbar .container {
|
|
width: auto;
|
|
}
|
|
}
|
|
@media (max-width: 979px) and (min-width: 768px) {
|
|
.navbar .container {
|
|
width: 724px;
|
|
}
|
|
}
|
|
@media (min-width: 1200px) {
|
|
.navbar .container {
|
|
width: 1170px;
|
|
}
|
|
}
|
|
.navbar .container img {
|
|
margin: 5px 0 0 4px;
|
|
}
|
|
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Serializer</h1><h4><small>package <a href="../haxe/index.html">haxe</a></small></h4> <p class="availability"><hr/><em>Available on all platforms</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>The Serializer class can be used to encode values and objects into a <code><a href="../String.html">String</a></code>,
|
|
from which the <code><a href="../haxe/Unserializer.html">Unserializer</a></code> class can recreate the original representation.</p>
|
|
<p>This class can be used in two ways:</p><ul><li>create a <code>new <a href="../haxe/Serializer.html">Serializer</a>()</code> instance, call its <code>serialize()</code> method with
|
|
any argument and finally retrieve the String representation from
|
|
<code>toString()</code></li><li>call <code><a href="../haxe/Serializer.html#run">Serializer.run</a>()</code> to obtain the serialized representation of a
|
|
single argument</li></ul>
|
|
<p>Serialization is guaranteed to work for all haxe-defined classes, but may
|
|
or may not work for instances of external/native classes.</p>
|
|
<p>The specification of the serialization format can be found here:
|
|
<a href="https://haxe.org/manual/serialization/format">https://haxe.org/manual/serialization/format</a></p></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3><p><code><a href="#new"><span class="identifier">new</span></a> ()</code></p></h3><div class="doc"><p>Creates a new Serializer instance.</p>
|
|
<p>Subsequent calls to <code>this.<a href="#serialize">serialize</a></code> will append values to the
|
|
internal buffer of this String. Once complete, the contents can be
|
|
retrieved through a call to <code>this.<a href="#toString">toString</a></code>.</p>
|
|
<p>Each Serializer instance maintains its own cache if this.useCache` is
|
|
true.</p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="useCache"></a><h3><p><code><a href="../haxe/Serializer.html#useCache"><span class="identifier">useCache</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></p></h3><div class="doc"><p>The individual cache setting for <code>this</code> Serializer instance.</p>
|
|
<p>See USE_CACHE for a complete description.</p></div></div><div class="field "><a name="useEnumIndex"></a><h3><p><code><a href="../haxe/Serializer.html#useEnumIndex"><span class="identifier">useEnumIndex</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></p></h3><div class="doc"><p>The individual enum index setting for <code>this</code> Serializer instance.</p>
|
|
<p>See USE_ENUM_INDEX for a complete description.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="serialize"></a><h3><p><code><a href="#serialize"><span class="identifier">serialize</span></a> (<span style="white-space:nowrap">v:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="../Dynamic.html">Dynamic</a></span>):<a class="type" title="The standard Void type." href="../Void.html">Void</a></code></p></h3><div class="doc"><p>Serializes <code>v</code>.</p>
|
|
<p>All haxe-defined values and objects with the exception of functions can
|
|
be serialized. Serialization of external/native objects is not
|
|
guaranteed to work.</p>
|
|
<p>The values of <code>this.<a href="#useCache">useCache</a></code> and <code>this.<a href="#useEnumIndex">useEnumIndex</a></code> may affect
|
|
serialization output.</p></div></div><div class="field "><a name="serializeException"></a><h3><p><code><a href="#serializeException"><span class="identifier">serializeException</span></a> (<span style="white-space:nowrap">e:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="../Dynamic.html">Dynamic</a></span>):<a class="type" title="The standard Void type." href="../Void.html">Void</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="toString"></a><h3><p><code><a href="#toString"><span class="identifier">toString</span></a> ():<a class="type" title="The basic String class." href="../String.html">String</a></code></p></h3><div class="doc"><p>Return the String representation of <code>this</code> Serializer.</p>
|
|
<p>The exact format specification can be found here:
|
|
https://haxe.org/manual/serialization/format</p></div></div></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="USE_CACHE"></a><h3><p><code><span class="label">static</span><a href="../haxe/Serializer.html#USE_CACHE"><span class="identifier">USE_CACHE</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a><span> = false</span></code></p></h3><div class="doc"><p>If the values you are serializing can contain circular references or
|
|
objects repetitions, you should set <code>USE_CACHE</code> to true to prevent
|
|
infinite loops.</p>
|
|
<p>This may also reduce the size of serialization Strings at the expense of
|
|
performance.</p>
|
|
<p>This value can be changed for individual instances of Serializer by
|
|
setting their useCache field.</p></div></div><div class="field "><a name="USE_ENUM_INDEX"></a><h3><p><code><span class="label">static</span><a href="../haxe/Serializer.html#USE_ENUM_INDEX"><span class="identifier">USE_ENUM_INDEX</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a><span> = false</span></code></p></h3><div class="doc"><p>Use constructor indexes for enums instead of names.</p>
|
|
<p>This may reduce the size of serialization Strings, but makes them less
|
|
suited for long-term storage: If constructors are removed or added from
|
|
the enum, the indices may no longer match.</p>
|
|
<p>This value can be changed for individual instances of Serializer by
|
|
setting their useEnumIndex field.</p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="run"></a><h3><p><code><span class="label">static</span><a href="#run"><span class="identifier">run</span></a> (<span style="white-space:nowrap">v:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="../Dynamic.html">Dynamic</a></span>):<a class="type" title="The basic String class." href="../String.html">String</a></code></p></h3><div class="doc"><p>Serializes <code>v</code> and returns the String representation.</p>
|
|
<p>This is a convenience function for creating a new instance of
|
|
Serializer, serialize <code>v</code> into it and obtain the result through a call
|
|
to toString().</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">© 2017 <a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="..//highlighter.js"></script><link href="../highlighter.css" rel="stylesheet"/></body></html> |