aboutsummaryrefslogtreecommitdiff
path: root/doc/modules
diff options
context:
space:
mode:
Diffstat (limited to 'doc/modules')
-rw-r--r--doc/modules/lyaml.explicit.html267
-rw-r--r--doc/modules/lyaml.functional.html236
-rw-r--r--doc/modules/lyaml.html224
-rw-r--r--doc/modules/lyaml.implicit.html533
4 files changed, 1260 insertions, 0 deletions
diff --git a/doc/modules/lyaml.explicit.html b/doc/modules/lyaml.explicit.html
new file mode 100644
index 000000000000..2667c4e006b2
--- /dev/null
+++ b/doc/modules/lyaml.explicit.html
@@ -0,0 +1,267 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+ <title>lyaml 6.2.8 Reference</title>
+ <link rel="stylesheet" href="../ldoc.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+ <div id="product_logo"></div>
+ <div id="product_name"><big><b></b></big></div>
+ <div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>lyaml 6.2.8</h1>
+
+<ul>
+ <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+ <li><a href="../modules/lyaml.html">lyaml</a></li>
+ <li><strong>lyaml.explicit</strong></li>
+ <li><a href="../modules/lyaml.functional.html">lyaml.functional</a></li>
+ <li><a href="../modules/lyaml.implicit.html">lyaml.implicit</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>lyaml.explicit</code></h1>
+<p>
+
+</p>
+<p>
+
+</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#bool">bool (value)</a></td>
+ <td class="summary">Parse the value following an explicit <code>!!bool</code> tag.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#float">float (value)</a></td>
+ <td class="summary">Parse the value following an explicit <code>!!float</code> tag.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#int">int (value)</a></td>
+ <td class="summary">Parse the value following an explicit <code>!!int</code> tag.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#null">null ()</a></td>
+ <td class="summary">Parse an explicit <code>!!null</code> tag.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#str">str (value)</a></td>
+ <td class="summary">Parse the value following an explicit <code>!!str</code> tag.</td>
+ </tr>
+</table>
+
+<br/>
+<br/>
+
+
+ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "bool"></a>
+ <strong>bool (value)</strong>
+ </dt>
+ <dd>
+ Parse the value following an explicit <code>!!bool</code> tag.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><a class="type" href="../modules/lyaml.explicit.html#bool">bool</a></span>
+ boolean equivalent, if a valid value was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_bool = explicit.bool(tagarg)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "float"></a>
+ <strong>float (value)</strong>
+ </dt>
+ <dd>
+ Parse the value following an explicit <code>!!float</code> tag.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">number</span></span>
+ float equivalent, if a valid value was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_float = explicit.float(tagarg)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "int"></a>
+ <strong>int (value)</strong>
+ </dt>
+ <dd>
+ Parse the value following an explicit <code>!!int</code> tag.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><a class="type" href="../modules/lyaml.explicit.html#int">int</a></span>
+ integer equivalent, if a valid value was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_int = explicit.int(tagarg)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "null"></a>
+ <strong>null ()</strong>
+ </dt>
+ <dd>
+ Parse an explicit <code>!!null</code> tag.
+
+
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">lyaml.null</span></span>
+
+
+
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">null = explicit.null(tagarg)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "str"></a>
+ <strong>str (value)</strong>
+ </dt>
+ <dd>
+ Parse the value following an explicit <code>!!str</code> tag.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ <em>value</em> which was a string already
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">tagarg = explicit.str(tagarg)</pre>
+ </ul>
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated 2022-10-22 17:12:03 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>
diff --git a/doc/modules/lyaml.functional.html b/doc/modules/lyaml.functional.html
new file mode 100644
index 000000000000..b003a961ff28
--- /dev/null
+++ b/doc/modules/lyaml.functional.html
@@ -0,0 +1,236 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+ <title>lyaml 6.2.8 Reference</title>
+ <link rel="stylesheet" href="../ldoc.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+ <div id="product_logo"></div>
+ <div id="product_name"><big><b></b></big></div>
+ <div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>lyaml 6.2.8</h1>
+
+<ul>
+ <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+<li><a href="#Tables">Tables</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+ <li><a href="../modules/lyaml.html">lyaml</a></li>
+ <li><a href="../modules/lyaml.explicit.html">lyaml.explicit</a></li>
+ <li><strong>lyaml.functional</strong></li>
+ <li><a href="../modules/lyaml.implicit.html">lyaml.implicit</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>lyaml.functional</code></h1>
+<p>
+
+</p>
+<p>
+
+</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#isnull">isnull (x)</a></td>
+ <td class="summary"><code>lyaml.null</code> predicate.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#iscallable">iscallable (x)</a></td>
+ <td class="summary">Callable predicate.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#anyof">anyof (fns)</a></td>
+ <td class="summary">Compose a function to try each callable with supplied args.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#id">id (...)</a></td>
+ <td class="summary">Return arguments unchanged.</td>
+ </tr>
+</table>
+<h2><a href="#Tables">Tables</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#NULL">NULL</a></td>
+ <td class="summary"><code>lyaml.null</code> value.</td>
+ </tr>
+</table>
+
+<br/>
+<br/>
+
+
+ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "isnull"></a>
+ <strong>isnull (x)</strong>
+ </dt>
+ <dd>
+ <code>lyaml.null</code> predicate.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">x</span>
+ operand
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">bool</span></span>
+ <code>true</code> if <em>x</em> is <code>lyaml.null</code>.
+ </ol>
+
+
+
+
+</dd>
+ <dt>
+ <a name = "iscallable"></a>
+ <strong>iscallable (x)</strong>
+ </dt>
+ <dd>
+ Callable predicate.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">x</span>
+ operand
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">bool</span></span>
+ <code>true</code> if <em>x</em> is a function has a __call metamethod
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">r = iscallable(x) <span class="keyword">and</span> x(...)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "anyof"></a>
+ <strong>anyof (fns)</strong>
+ </dt>
+ <dd>
+ Compose a function to try each callable with supplied args.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">fns</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+ list of functions to try
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">function</span></span>
+
+<p>a new function to call <em>...</em> functions, stopping</p>
+<pre><code>and returning the first non-nil result, if any
+</code></pre>
+
+ </ol>
+
+
+
+
+</dd>
+ <dt>
+ <a name = "id"></a>
+ <strong>id (...)</strong>
+ </dt>
+ <dd>
+ Return arguments unchanged.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">...</span>
+ arguments
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <em>...</em>
+ </ol>
+
+
+
+
+</dd>
+</dl>
+ <h2 class="section-header "><a name="Tables"></a>Tables</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "NULL"></a>
+ <strong>NULL</strong>
+ </dt>
+ <dd>
+ <code>lyaml.null</code> value.
+
+
+
+
+
+
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated 2022-10-22 17:12:03 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>
diff --git a/doc/modules/lyaml.html b/doc/modules/lyaml.html
new file mode 100644
index 000000000000..2deb6a4b6be7
--- /dev/null
+++ b/doc/modules/lyaml.html
@@ -0,0 +1,224 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+ <title>lyaml 6.2.8 Reference</title>
+ <link rel="stylesheet" href="../ldoc.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+ <div id="product_logo"></div>
+ <div id="product_name"><big><b></b></big></div>
+ <div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>lyaml 6.2.8</h1>
+
+<ul>
+ <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+<li><a href="#Tables">Tables</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+ <li><strong>lyaml</strong></li>
+ <li><a href="../modules/lyaml.explicit.html">lyaml.explicit</a></li>
+ <li><a href="../modules/lyaml.functional.html">lyaml.functional</a></li>
+ <li><a href="../modules/lyaml.implicit.html">lyaml.implicit</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>lyaml</code></h1>
+<p>
+
+</p>
+<p>
+
+</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#dump">dump (documents[, opts])</a></td>
+ <td class="summary">Dump a list of Lua tables to an equivalent YAML stream.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#load">load (s[, opts])</a></td>
+ <td class="summary">Load a YAML stream into a Lua table.</td>
+ </tr>
+</table>
+<h2><a href="#Tables">Tables</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#dumper_opts">dumper_opts</a></td>
+ <td class="summary">Dump options table.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#loader_opts">loader_opts</a></td>
+ <td class="summary">Load options table.</td>
+ </tr>
+</table>
+
+<br/>
+<br/>
+
+
+ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "dump"></a>
+ <strong>dump (documents[, opts])</strong>
+ </dt>
+ <dd>
+ Dump a list of Lua tables to an equivalent YAML stream.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">documents</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+ a sequence of Lua tables.
+ </li>
+ <li><span class="parameter">opts</span>
+ <span class="types"><span class="type">dumper_opts</span></span>
+ initialisation options
+ (<em>optional</em>)
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ equivalest YAML stream
+ </ol>
+
+
+
+
+</dd>
+ <dt>
+ <a name = "load"></a>
+ <strong>load (s[, opts])</strong>
+ </dt>
+ <dd>
+ Load a YAML stream into a Lua table.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">s</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ YAML stream
+ </li>
+ <li><span class="parameter">opts</span>
+ <span class="types"><span class="type">loader_opts</span></span>
+ initialisation options
+ (<em>optional</em>)
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+ Lua table equivalent of stream <em>s</em>
+ </ol>
+
+
+
+
+</dd>
+</dl>
+ <h2 class="section-header "><a name="Tables"></a>Tables</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "dumper_opts"></a>
+ <strong>dumper_opts</strong>
+ </dt>
+ <dd>
+ Dump options table.
+
+
+ <h3>Fields:</h3>
+ <ul>
+ <li><span class="parameter">anchors</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+ map initial anchor names to values
+ </li>
+ <li><span class="parameter">implicit_scalar</span>
+ <span class="types"><span class="type">function</span></span>
+ parse implicit scalar values
+ </li>
+ </ul>
+
+
+
+
+
+</dd>
+ <dt>
+ <a name = "loader_opts"></a>
+ <strong>loader_opts</strong>
+ </dt>
+ <dd>
+ Load options table.
+
+
+ <h3>Fields:</h3>
+ <ul>
+ <li><span class="parameter">all</span>
+ <span class="types"><span class="type">boolean</span></span>
+ load all documents from the stream
+ </li>
+ <li><span class="parameter">explicit_scalar</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
+ map full tag-names to parser functions
+ </li>
+ <li><span class="parameter">implicit_scalar</span>
+ <span class="types"><span class="type">function</span></span>
+ parse implicit scalar values
+ </li>
+ </ul>
+
+
+
+
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated 2022-10-22 17:12:03 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>
diff --git a/doc/modules/lyaml.implicit.html b/doc/modules/lyaml.implicit.html
new file mode 100644
index 000000000000..935579f705c6
--- /dev/null
+++ b/doc/modules/lyaml.implicit.html
@@ -0,0 +1,533 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+ <title>lyaml 6.2.8 Reference</title>
+ <link rel="stylesheet" href="../ldoc.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+ <div id="product_logo"></div>
+ <div id="product_name"><big><b></b></big></div>
+ <div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>lyaml 6.2.8</h1>
+
+<ul>
+ <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+ <li><a href="../modules/lyaml.html">lyaml</a></li>
+ <li><a href="../modules/lyaml.explicit.html">lyaml.explicit</a></li>
+ <li><a href="../modules/lyaml.functional.html">lyaml.functional</a></li>
+ <li><strong>lyaml.implicit</strong></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>lyaml.implicit</code></h1>
+<p>
+
+</p>
+<p>
+
+</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#null">null (value)</a></td>
+ <td class="summary">Parse a null token to a null value.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#bool">bool (value)</a></td>
+ <td class="summary">Parse a boolean token to the equivalent value.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#binary">binary (value)</a></td>
+ <td class="summary">Parse a binary token, such as '0b1010_0111_0100_1010_1110'.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#octal">octal (value)</a></td>
+ <td class="summary">Parse an octal token, such as '012345'.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#decimal">decimal (value)</a></td>
+ <td class="summary">Parse a decimal token, such as '0' or '12345'.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#hexadecimal">hexadecimal (value)</a></td>
+ <td class="summary">Parse a hexadecimal token, such as '0xdeadbeef'.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#sexagesimal">sexagesimal (value)</a></td>
+ <td class="summary">Parse a sexagesimal token, such as '190:20:30'.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#nan">nan (value)</a></td>
+ <td class="summary">Parse a <code>nan</code> token.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#inf">inf (value)</a></td>
+ <td class="summary">Parse a signed <code>inf</code> token.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#float">float (value)</a></td>
+ <td class="summary">Parse a floating point number token, such as '1e-3' or '-0.12'.</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#sexfloat">sexfloat (value)</a></td>
+ <td class="summary">Parse a sexagesimal float, such as '190:20:30.15'.</td>
+ </tr>
+</table>
+
+<br/>
+<br/>
+
+
+ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "null"></a>
+ <strong>null (value)</strong>
+ </dt>
+ <dd>
+ Parse a null token to a null value.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ lyaml.null, for an empty string or literal ~
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ nil otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_null = implicit.null(token)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "bool"></a>
+ <strong>bool (value)</strong>
+ </dt>
+ <dd>
+ Parse a boolean token to the equivalent value.
+ Treats capilalized, lower and upper-cased variants of true/false,
+ yes/no or on/off tokens as boolean <code>true</code> and <code>false</code> values.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><a class="type" href="../modules/lyaml.implicit.html#bool">bool</a></span>
+ if a valid boolean token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_bool = implicit.bool(token)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "binary"></a>
+ <strong>binary (value)</strong>
+ </dt>
+ <dd>
+ Parse a binary token, such as '0b1010_0111_0100_1010_1110'.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">int</span></span>
+ integer equivalent, if a valid token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_int = implicit.binary(value)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "octal"></a>
+ <strong>octal (value)</strong>
+ </dt>
+ <dd>
+ Parse an octal token, such as '012345'.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">int</span></span>
+ integer equivalent, if a valid token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_int = implicit.octal(value)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "decimal"></a>
+ <strong>decimal (value)</strong>
+ </dt>
+ <dd>
+ Parse a decimal token, such as '0' or '12345'.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">int</span></span>
+ integer equivalent, if a valid token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_int = implicit.decimal(value)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "hexadecimal"></a>
+ <strong>hexadecimal (value)</strong>
+ </dt>
+ <dd>
+ Parse a hexadecimal token, such as '0xdeadbeef'.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">int</span></span>
+ integer equivalent, if a valid token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_int = implicit.hexadecimal(value)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "sexagesimal"></a>
+ <strong>sexagesimal (value)</strong>
+ </dt>
+ <dd>
+ Parse a sexagesimal token, such as '190:20:30'.
+ Useful for times and angles.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">int</span></span>
+ integer equivalent, if a valid token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_int = implicit.sexagesimal(value)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "nan"></a>
+ <strong>nan (value)</strong>
+ </dt>
+ <dd>
+ Parse a <code>nan</code> token.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><a class="type" href="../modules/lyaml.implicit.html#nan">nan</a></span>
+ not-a-number, if a valid token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_nan = implicit.nan(value)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "inf"></a>
+ <strong>inf (value)</strong>
+ </dt>
+ <dd>
+ Parse a signed <code>inf</code> token.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">number</span></span>
+ plus/minus-infinity, if a valid token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_inf = implicit.inf(value)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "float"></a>
+ <strong>float (value)</strong>
+ </dt>
+ <dd>
+ Parse a floating point number token, such as '1e-3' or '-0.12'.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">number</span></span>
+ float equivalent, if a valid token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_float = implicit.float(value)</pre>
+ </ul>
+
+</dd>
+ <dt>
+ <a name = "sexfloat"></a>
+ <strong>sexfloat (value)</strong>
+ </dt>
+ <dd>
+ Parse a sexagesimal float, such as '190:20:30.15'.
+ Useful for times and angles.
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">value</span>
+ <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
+ token
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><span class="type">number</span></span>
+ float equivalent, if a valid token was recognized
+ </ol>
+ <h3>Or</h3>
+ <ol>
+
+ <span class="types"><span class="type">nil</span></span>
+ otherwise, nil
+ </ol>
+
+
+
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">maybe_float = implicit.sexfloat(value)</pre>
+ </ul>
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated 2022-10-22 17:12:03 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-06 12:27:20 +0000