1*2bc180efSBaptiste Daroussin<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 2*2bc180efSBaptiste Daroussin "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3*2bc180efSBaptiste Daroussin<html> 4*2bc180efSBaptiste Daroussin<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> 5*2bc180efSBaptiste Daroussin<head> 6*2bc180efSBaptiste Daroussin <title>lyaml 6.2.8 Reference</title> 7*2bc180efSBaptiste Daroussin <link rel="stylesheet" href="../ldoc.css" type="text/css" /> 8*2bc180efSBaptiste Daroussin</head> 9*2bc180efSBaptiste Daroussin<body> 10*2bc180efSBaptiste Daroussin 11*2bc180efSBaptiste Daroussin<div id="container"> 12*2bc180efSBaptiste Daroussin 13*2bc180efSBaptiste Daroussin<div id="product"> 14*2bc180efSBaptiste Daroussin <div id="product_logo"></div> 15*2bc180efSBaptiste Daroussin <div id="product_name"><big><b></b></big></div> 16*2bc180efSBaptiste Daroussin <div id="product_description"></div> 17*2bc180efSBaptiste Daroussin</div> <!-- id="product" --> 18*2bc180efSBaptiste Daroussin 19*2bc180efSBaptiste Daroussin 20*2bc180efSBaptiste Daroussin<div id="main"> 21*2bc180efSBaptiste Daroussin 22*2bc180efSBaptiste Daroussin 23*2bc180efSBaptiste Daroussin<!-- Menu --> 24*2bc180efSBaptiste Daroussin 25*2bc180efSBaptiste Daroussin<div id="navigation"> 26*2bc180efSBaptiste Daroussin<br/> 27*2bc180efSBaptiste Daroussin<h1>lyaml 6.2.8</h1> 28*2bc180efSBaptiste Daroussin 29*2bc180efSBaptiste Daroussin<ul> 30*2bc180efSBaptiste Daroussin <li><a href="../index.html">Index</a></li> 31*2bc180efSBaptiste Daroussin</ul> 32*2bc180efSBaptiste Daroussin 33*2bc180efSBaptiste Daroussin<h2>Contents</h2> 34*2bc180efSBaptiste Daroussin<ul> 35*2bc180efSBaptiste Daroussin<li><a href="#Functions">Functions</a></li> 36*2bc180efSBaptiste Daroussin<li><a href="#Tables">Tables</a></li> 37*2bc180efSBaptiste Daroussin</ul> 38*2bc180efSBaptiste Daroussin 39*2bc180efSBaptiste Daroussin 40*2bc180efSBaptiste Daroussin<h2>Modules</h2> 41*2bc180efSBaptiste Daroussin<ul class="nowrap"> 42*2bc180efSBaptiste Daroussin <li><strong>lyaml</strong></li> 43*2bc180efSBaptiste Daroussin <li><a href="../modules/lyaml.explicit.html">lyaml.explicit</a></li> 44*2bc180efSBaptiste Daroussin <li><a href="../modules/lyaml.functional.html">lyaml.functional</a></li> 45*2bc180efSBaptiste Daroussin <li><a href="../modules/lyaml.implicit.html">lyaml.implicit</a></li> 46*2bc180efSBaptiste Daroussin</ul> 47*2bc180efSBaptiste Daroussin 48*2bc180efSBaptiste Daroussin</div> 49*2bc180efSBaptiste Daroussin 50*2bc180efSBaptiste Daroussin<div id="content"> 51*2bc180efSBaptiste Daroussin 52*2bc180efSBaptiste Daroussin<h1>Module <code>lyaml</code></h1> 53*2bc180efSBaptiste Daroussin<p> 54*2bc180efSBaptiste Daroussin 55*2bc180efSBaptiste Daroussin</p> 56*2bc180efSBaptiste Daroussin<p> 57*2bc180efSBaptiste Daroussin 58*2bc180efSBaptiste Daroussin</p> 59*2bc180efSBaptiste Daroussin 60*2bc180efSBaptiste Daroussin 61*2bc180efSBaptiste Daroussin<h2><a href="#Functions">Functions</a></h2> 62*2bc180efSBaptiste Daroussin<table class="function_list"> 63*2bc180efSBaptiste Daroussin <tr> 64*2bc180efSBaptiste Daroussin <td class="name" nowrap><a href="#dump">dump (documents[, opts])</a></td> 65*2bc180efSBaptiste Daroussin <td class="summary">Dump a list of Lua tables to an equivalent YAML stream.</td> 66*2bc180efSBaptiste Daroussin </tr> 67*2bc180efSBaptiste Daroussin <tr> 68*2bc180efSBaptiste Daroussin <td class="name" nowrap><a href="#load">load (s[, opts])</a></td> 69*2bc180efSBaptiste Daroussin <td class="summary">Load a YAML stream into a Lua table.</td> 70*2bc180efSBaptiste Daroussin </tr> 71*2bc180efSBaptiste Daroussin</table> 72*2bc180efSBaptiste Daroussin<h2><a href="#Tables">Tables</a></h2> 73*2bc180efSBaptiste Daroussin<table class="function_list"> 74*2bc180efSBaptiste Daroussin <tr> 75*2bc180efSBaptiste Daroussin <td class="name" nowrap><a href="#dumper_opts">dumper_opts</a></td> 76*2bc180efSBaptiste Daroussin <td class="summary">Dump options table.</td> 77*2bc180efSBaptiste Daroussin </tr> 78*2bc180efSBaptiste Daroussin <tr> 79*2bc180efSBaptiste Daroussin <td class="name" nowrap><a href="#loader_opts">loader_opts</a></td> 80*2bc180efSBaptiste Daroussin <td class="summary">Load options table.</td> 81*2bc180efSBaptiste Daroussin </tr> 82*2bc180efSBaptiste Daroussin</table> 83*2bc180efSBaptiste Daroussin 84*2bc180efSBaptiste Daroussin<br/> 85*2bc180efSBaptiste Daroussin<br/> 86*2bc180efSBaptiste Daroussin 87*2bc180efSBaptiste Daroussin 88*2bc180efSBaptiste Daroussin <h2 class="section-header "><a name="Functions"></a>Functions</h2> 89*2bc180efSBaptiste Daroussin 90*2bc180efSBaptiste Daroussin <dl class="function"> 91*2bc180efSBaptiste Daroussin <dt> 92*2bc180efSBaptiste Daroussin <a name = "dump"></a> 93*2bc180efSBaptiste Daroussin <strong>dump (documents[, opts])</strong> 94*2bc180efSBaptiste Daroussin </dt> 95*2bc180efSBaptiste Daroussin <dd> 96*2bc180efSBaptiste Daroussin Dump a list of Lua tables to an equivalent YAML stream. 97*2bc180efSBaptiste Daroussin 98*2bc180efSBaptiste Daroussin 99*2bc180efSBaptiste Daroussin <h3>Parameters:</h3> 100*2bc180efSBaptiste Daroussin <ul> 101*2bc180efSBaptiste Daroussin <li><span class="parameter">documents</span> 102*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span> 103*2bc180efSBaptiste Daroussin a sequence of Lua tables. 104*2bc180efSBaptiste Daroussin </li> 105*2bc180efSBaptiste Daroussin <li><span class="parameter">opts</span> 106*2bc180efSBaptiste Daroussin <span class="types"><span class="type">dumper_opts</span></span> 107*2bc180efSBaptiste Daroussin initialisation options 108*2bc180efSBaptiste Daroussin (<em>optional</em>) 109*2bc180efSBaptiste Daroussin </li> 110*2bc180efSBaptiste Daroussin </ul> 111*2bc180efSBaptiste Daroussin 112*2bc180efSBaptiste Daroussin <h3>Returns:</h3> 113*2bc180efSBaptiste Daroussin <ol> 114*2bc180efSBaptiste Daroussin 115*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 116*2bc180efSBaptiste Daroussin equivalest YAML stream 117*2bc180efSBaptiste Daroussin </ol> 118*2bc180efSBaptiste Daroussin 119*2bc180efSBaptiste Daroussin 120*2bc180efSBaptiste Daroussin 121*2bc180efSBaptiste Daroussin 122*2bc180efSBaptiste Daroussin</dd> 123*2bc180efSBaptiste Daroussin <dt> 124*2bc180efSBaptiste Daroussin <a name = "load"></a> 125*2bc180efSBaptiste Daroussin <strong>load (s[, opts])</strong> 126*2bc180efSBaptiste Daroussin </dt> 127*2bc180efSBaptiste Daroussin <dd> 128*2bc180efSBaptiste Daroussin Load a YAML stream into a Lua table. 129*2bc180efSBaptiste Daroussin 130*2bc180efSBaptiste Daroussin 131*2bc180efSBaptiste Daroussin <h3>Parameters:</h3> 132*2bc180efSBaptiste Daroussin <ul> 133*2bc180efSBaptiste Daroussin <li><span class="parameter">s</span> 134*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 135*2bc180efSBaptiste Daroussin YAML stream 136*2bc180efSBaptiste Daroussin </li> 137*2bc180efSBaptiste Daroussin <li><span class="parameter">opts</span> 138*2bc180efSBaptiste Daroussin <span class="types"><span class="type">loader_opts</span></span> 139*2bc180efSBaptiste Daroussin initialisation options 140*2bc180efSBaptiste Daroussin (<em>optional</em>) 141*2bc180efSBaptiste Daroussin </li> 142*2bc180efSBaptiste Daroussin </ul> 143*2bc180efSBaptiste Daroussin 144*2bc180efSBaptiste Daroussin <h3>Returns:</h3> 145*2bc180efSBaptiste Daroussin <ol> 146*2bc180efSBaptiste Daroussin 147*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span> 148*2bc180efSBaptiste Daroussin Lua table equivalent of stream <em>s</em> 149*2bc180efSBaptiste Daroussin </ol> 150*2bc180efSBaptiste Daroussin 151*2bc180efSBaptiste Daroussin 152*2bc180efSBaptiste Daroussin 153*2bc180efSBaptiste Daroussin 154*2bc180efSBaptiste Daroussin</dd> 155*2bc180efSBaptiste Daroussin</dl> 156*2bc180efSBaptiste Daroussin <h2 class="section-header "><a name="Tables"></a>Tables</h2> 157*2bc180efSBaptiste Daroussin 158*2bc180efSBaptiste Daroussin <dl class="function"> 159*2bc180efSBaptiste Daroussin <dt> 160*2bc180efSBaptiste Daroussin <a name = "dumper_opts"></a> 161*2bc180efSBaptiste Daroussin <strong>dumper_opts</strong> 162*2bc180efSBaptiste Daroussin </dt> 163*2bc180efSBaptiste Daroussin <dd> 164*2bc180efSBaptiste Daroussin Dump options table. 165*2bc180efSBaptiste Daroussin 166*2bc180efSBaptiste Daroussin 167*2bc180efSBaptiste Daroussin <h3>Fields:</h3> 168*2bc180efSBaptiste Daroussin <ul> 169*2bc180efSBaptiste Daroussin <li><span class="parameter">anchors</span> 170*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span> 171*2bc180efSBaptiste Daroussin map initial anchor names to values 172*2bc180efSBaptiste Daroussin </li> 173*2bc180efSBaptiste Daroussin <li><span class="parameter">implicit_scalar</span> 174*2bc180efSBaptiste Daroussin <span class="types"><span class="type">function</span></span> 175*2bc180efSBaptiste Daroussin parse implicit scalar values 176*2bc180efSBaptiste Daroussin </li> 177*2bc180efSBaptiste Daroussin </ul> 178*2bc180efSBaptiste Daroussin 179*2bc180efSBaptiste Daroussin 180*2bc180efSBaptiste Daroussin 181*2bc180efSBaptiste Daroussin 182*2bc180efSBaptiste Daroussin 183*2bc180efSBaptiste Daroussin</dd> 184*2bc180efSBaptiste Daroussin <dt> 185*2bc180efSBaptiste Daroussin <a name = "loader_opts"></a> 186*2bc180efSBaptiste Daroussin <strong>loader_opts</strong> 187*2bc180efSBaptiste Daroussin </dt> 188*2bc180efSBaptiste Daroussin <dd> 189*2bc180efSBaptiste Daroussin Load options table. 190*2bc180efSBaptiste Daroussin 191*2bc180efSBaptiste Daroussin 192*2bc180efSBaptiste Daroussin <h3>Fields:</h3> 193*2bc180efSBaptiste Daroussin <ul> 194*2bc180efSBaptiste Daroussin <li><span class="parameter">all</span> 195*2bc180efSBaptiste Daroussin <span class="types"><span class="type">boolean</span></span> 196*2bc180efSBaptiste Daroussin load all documents from the stream 197*2bc180efSBaptiste Daroussin </li> 198*2bc180efSBaptiste Daroussin <li><span class="parameter">explicit_scalar</span> 199*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span> 200*2bc180efSBaptiste Daroussin map full tag-names to parser functions 201*2bc180efSBaptiste Daroussin </li> 202*2bc180efSBaptiste Daroussin <li><span class="parameter">implicit_scalar</span> 203*2bc180efSBaptiste Daroussin <span class="types"><span class="type">function</span></span> 204*2bc180efSBaptiste Daroussin parse implicit scalar values 205*2bc180efSBaptiste Daroussin </li> 206*2bc180efSBaptiste Daroussin </ul> 207*2bc180efSBaptiste Daroussin 208*2bc180efSBaptiste Daroussin 209*2bc180efSBaptiste Daroussin 210*2bc180efSBaptiste Daroussin 211*2bc180efSBaptiste Daroussin 212*2bc180efSBaptiste Daroussin</dd> 213*2bc180efSBaptiste Daroussin</dl> 214*2bc180efSBaptiste Daroussin 215*2bc180efSBaptiste Daroussin 216*2bc180efSBaptiste Daroussin</div> <!-- id="content" --> 217*2bc180efSBaptiste Daroussin</div> <!-- id="main" --> 218*2bc180efSBaptiste Daroussin<div id="about"> 219*2bc180efSBaptiste Daroussin<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> 220*2bc180efSBaptiste Daroussin<i style="float:right;">Last updated 2022-10-22 17:12:03 </i> 221*2bc180efSBaptiste Daroussin</div> <!-- id="about" --> 222*2bc180efSBaptiste Daroussin</div> <!-- id="container" --> 223*2bc180efSBaptiste Daroussin</body> 224*2bc180efSBaptiste Daroussin</html> 225