193 lines
7.7 KiB
HTML
193 lines
7.7 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
|
"http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
<html lang='en'>
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" >
|
|
<title>dyaml.constructor - D:YAML 0.1 API documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="css/style.css">
|
|
</head>
|
|
|
|
<body><div id="top">
|
|
<div id="header">
|
|
<img id="logo" alt="D:YAML logo" src="images/logo.png"><a id="main-heading" href="index.html">D:YAML 0.1 API documentation</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="navigation">
|
|
<div class="navblock">
|
|
<div id="toctop">
|
|
<ul><li><a href="../index.html">Documentation home</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="navblock">
|
|
<ul><li><a href="index.html">Main page</a></li>
|
|
<li><a href="dyaml.constructor.html">dyaml.constructor</a></li>
|
|
<li><a href="dyaml.exception.html">dyaml.exception</a></li>
|
|
<li><a href="dyaml.loader.html">dyaml.loader</a></li>
|
|
<li><a href="dyaml.node.html">dyaml.node</a></li>
|
|
<li><a href="dyaml.resolver.html">dyaml.resolver</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="content">
|
|
<h1>dyaml.constructor</h1>
|
|
<!-- Generated by Ddoc from dyaml/constructor.d -->
|
|
<p>Implements a class that processes YAML mappings, sequences and scalars into
|
|
nodes. This can be used to implement custom data types. A tutorial can be
|
|
found <a href="../tutorials/custom_types.html">here</a>.</p>
|
|
|
|
<dl><dt class="d_decl">class <a name="ConstructorException"></a><span class="ddoc_psymbol">ConstructorException</span>: dyaml.exception.YAMLException;
|
|
</dt>
|
|
<dd><p>Exception thrown at constructor errors.
|
|
</p>
|
|
<p>Can be thrown by custom constructor functions.</p>
|
|
|
|
<dl><dt class="d_decl">this(string <b>msg</b>, Mark <b>start</b>, Mark <b>end</b>);
|
|
</dt>
|
|
<dd><p>Construct a ConstructorException.
|
|
</p>
|
|
<b>Parameters:</b><div class="pbr"><table class=parms><tr><td valign=top>string <b>msg</b></td>
|
|
<td valign=top>Error message.</td></tr>
|
|
<tr><td valign=top>Mark <b>start</b></td>
|
|
<td valign=top>Start position of the error context.</td></tr>
|
|
<tr><td valign=top>Mark <b>end</b></td>
|
|
<td valign=top>End position of the error context.</td></tr>
|
|
</table></div>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt class="d_decl">class <a name="Constructor"></a><span class="ddoc_psymbol">Constructor</span>;
|
|
</dt>
|
|
<dd><p>Constructs YAML values.
|
|
</p>
|
|
<p>Each YAML scalar, sequence or mapping has a tag specifying its data type.
|
|
<a name="Constructor"></a><span class="ddoc_psymbol">Constructor</span> uses user-specifyable functions to create a node of desired
|
|
data type from a scalar, sequence or mapping.
|
|
<br>
|
|
|
|
Each of these functions is associated with a tag, and can process either
|
|
a scalar, a sequence, or a mapping. The constructor passes each value to
|
|
the function with corresponding tag, which then returns the resulting value
|
|
that can be stored in a node.
|
|
<br>
|
|
|
|
If a tag is detected with no known constructor function, it is considered an error.</p>
|
|
|
|
<dl><dt class="d_decl">this(in bool <b>defaultConstructors</b> = true);
|
|
</dt>
|
|
<dd><p>Construct a Constructor.
|
|
</p>
|
|
<p>If you don't want to support default YAML tags/data types, you can use
|
|
<b>defaultConstructors</b> to disable constructor functions for these.
|
|
|
|
</p>
|
|
<b>Parameters:</b><div class="pbr"><table class=parms><tr><td valign=top>bool <b>defaultConstructors</b></td>
|
|
<td valign=top>Use constructors for default YAML tags?</td></tr>
|
|
</table></div>
|
|
|
|
</dd>
|
|
<dt class="d_decl">void <a name="addConstructor"></a><span class="ddoc_psymbol">addConstructor</span>(T, U)(in string <b>tag</b>, T function(Mark, Mark, U) <b>ctor</b>);
|
|
</dt>
|
|
<dd><p>Add a constructor function.
|
|
</p>
|
|
<p>The function passed must two Marks (determining start and end positions of
|
|
the node in file) and either a string (if constructing from scalar),
|
|
an array of Nodes (from sequence) or an array of Node.Pair (from mapping).
|
|
The value returned by this function will be stored in the resulring node.
|
|
|
|
</p>
|
|
<b>Parameters:</b><div class="pbr"><table class=parms><tr><td valign=top>tag</td>
|
|
<td valign=top>Tag for the function to handle.</td></tr>
|
|
<tr><td valign=top>ctor</td>
|
|
<td valign=top>Constructor function.</td></tr>
|
|
</table></div>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt class="d_decl">YAMLNull <a name="constructNull"></a><span class="ddoc_psymbol">constructNull</span>(Mark <b>start</b>, Mark <b>end</b>, string <b>value</b>);
|
|
</dt>
|
|
<dd><p>Construct a <b>null</b> node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">YAMLMerge <a name="constructMerge"></a><span class="ddoc_psymbol">constructMerge</span>(Mark <b>start</b>, Mark <b>end</b>, string <b>value</b>);
|
|
</dt>
|
|
<dd><p>Construct a merge node - a node that merges another node into a mapping.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">bool <a name="constructBool"></a><span class="ddoc_psymbol">constructBool</span>(Mark <b>start</b>, Mark <b>end</b>, string <b>value</b>);
|
|
</dt>
|
|
<dd><p>Construct a boolean node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">long <a name="constructLong"></a><span class="ddoc_psymbol">constructLong</span>(Mark <b>start</b>, Mark <b>end</b>, string <b>value</b>);
|
|
</dt>
|
|
<dd><p>Construct an integer (long) node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">real <a name="constructReal"></a><span class="ddoc_psymbol">constructReal</span>(Mark <b>start</b>, Mark <b>end</b>, string <b>value</b>);
|
|
</dt>
|
|
<dd><p>Construct a floating point (real) node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">ubyte[] <a name="constructBinary"></a><span class="ddoc_psymbol">constructBinary</span>(Mark <b>start</b>, Mark <b>end</b>, string <b>value</b>);
|
|
</dt>
|
|
<dd><p>Construct a binary (base64) node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">SysTime <a name="constructTimestamp"></a><span class="ddoc_psymbol">constructTimestamp</span>(Mark <b>start</b>, Mark <b>end</b>, string <b>value</b>);
|
|
</dt>
|
|
<dd><p>Construct a timestamp (SysTime) node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">string <a name="constructString"></a><span class="ddoc_psymbol">constructString</span>(Mark <b>start</b>, Mark <b>end</b>, string <b>value</b>);
|
|
</dt>
|
|
<dd><p>Construct a string node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">Pair[] <a name="getPairs"></a><span class="ddoc_psymbol">getPairs</span>(string <b>type</b>, Mark <b>start</b>, Mark <b>end</b>, Node[] <b>nodes</b>);
|
|
</dt>
|
|
<dd><p>Convert a sequence of single-element mappings into a sequence of pairs.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">Pair[] <a name="constructOrderedMap"></a><span class="ddoc_psymbol">constructOrderedMap</span>(Mark <b>start</b>, Mark <b>end</b>, Node[] <b>nodes</b>);
|
|
</dt>
|
|
<dd><p>Construct an ordered map (ordered sequence of key:value pairs without duplicates) node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">Pair[] <a name="constructPairs"></a><span class="ddoc_psymbol">constructPairs</span>(Mark <b>start</b>, Mark <b>end</b>, Node[] <b>nodes</b>);
|
|
</dt>
|
|
<dd><p>Construct a pairs (ordered sequence of key: value pairs allowing duplicates) node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">Node[] <a name="constructSet"></a><span class="ddoc_psymbol">constructSet</span>(Mark <b>start</b>, Mark <b>end</b>, Pair[] <b>pairs</b>);
|
|
</dt>
|
|
<dd><p>Construct a set node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">Node[] <a name="constructSequence"></a><span class="ddoc_psymbol">constructSequence</span>(Mark <b>start</b>, Mark <b>end</b>, Node[] <b>nodes</b>);
|
|
</dt>
|
|
<dd><p>Construct a sequence (array) node.</p>
|
|
|
|
</dd>
|
|
<dt class="d_decl">Pair[] <a name="constructMap"></a><span class="ddoc_psymbol">constructMap</span>(Mark <b>start</b>, Mark <b>end</b>, Pair[] <b>pairs</b>);
|
|
</dt>
|
|
<dd><p>Construct an unordered map (unordered set of key: value pairs without duplicates) node.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
<div id="copyright">
|
|
Copyright © Ferdinand Majerech 2011. Based on <a href="http://www.pyyaml.org">PyYAML</a> by Kirill Simonov. |
|
|
Page generated by Autodoc and <a href="http://www.digitalmars.com/d/2.0/ddoc.html">Ddoc</a>.
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|