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