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</ul> 37*2bc180efSBaptiste Daroussin 38*2bc180efSBaptiste Daroussin 39*2bc180efSBaptiste Daroussin<h2>Modules</h2> 40*2bc180efSBaptiste Daroussin<ul class="nowrap"> 41*2bc180efSBaptiste Daroussin <li><a href="../modules/lyaml.html">lyaml</a></li> 42*2bc180efSBaptiste Daroussin <li><strong>lyaml.explicit</strong></li> 43*2bc180efSBaptiste Daroussin <li><a href="../modules/lyaml.functional.html">lyaml.functional</a></li> 44*2bc180efSBaptiste Daroussin <li><a href="../modules/lyaml.implicit.html">lyaml.implicit</a></li> 45*2bc180efSBaptiste Daroussin</ul> 46*2bc180efSBaptiste Daroussin 47*2bc180efSBaptiste Daroussin</div> 48*2bc180efSBaptiste Daroussin 49*2bc180efSBaptiste Daroussin<div id="content"> 50*2bc180efSBaptiste Daroussin 51*2bc180efSBaptiste Daroussin<h1>Module <code>lyaml.explicit</code></h1> 52*2bc180efSBaptiste Daroussin<p> 53*2bc180efSBaptiste Daroussin 54*2bc180efSBaptiste Daroussin</p> 55*2bc180efSBaptiste Daroussin<p> 56*2bc180efSBaptiste Daroussin 57*2bc180efSBaptiste Daroussin</p> 58*2bc180efSBaptiste Daroussin 59*2bc180efSBaptiste Daroussin 60*2bc180efSBaptiste Daroussin<h2><a href="#Functions">Functions</a></h2> 61*2bc180efSBaptiste Daroussin<table class="function_list"> 62*2bc180efSBaptiste Daroussin <tr> 63*2bc180efSBaptiste Daroussin <td class="name" nowrap><a href="#bool">bool (value)</a></td> 64*2bc180efSBaptiste Daroussin <td class="summary">Parse the value following an explicit <code>!!bool</code> tag.</td> 65*2bc180efSBaptiste Daroussin </tr> 66*2bc180efSBaptiste Daroussin <tr> 67*2bc180efSBaptiste Daroussin <td class="name" nowrap><a href="#float">float (value)</a></td> 68*2bc180efSBaptiste Daroussin <td class="summary">Parse the value following an explicit <code>!!float</code> tag.</td> 69*2bc180efSBaptiste Daroussin </tr> 70*2bc180efSBaptiste Daroussin <tr> 71*2bc180efSBaptiste Daroussin <td class="name" nowrap><a href="#int">int (value)</a></td> 72*2bc180efSBaptiste Daroussin <td class="summary">Parse the value following an explicit <code>!!int</code> tag.</td> 73*2bc180efSBaptiste Daroussin </tr> 74*2bc180efSBaptiste Daroussin <tr> 75*2bc180efSBaptiste Daroussin <td class="name" nowrap><a href="#null">null ()</a></td> 76*2bc180efSBaptiste Daroussin <td class="summary">Parse an explicit <code>!!null</code> tag.</td> 77*2bc180efSBaptiste Daroussin </tr> 78*2bc180efSBaptiste Daroussin <tr> 79*2bc180efSBaptiste Daroussin <td class="name" nowrap><a href="#str">str (value)</a></td> 80*2bc180efSBaptiste Daroussin <td class="summary">Parse the value following an explicit <code>!!str</code> tag.</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 = "bool"></a> 93*2bc180efSBaptiste Daroussin <strong>bool (value)</strong> 94*2bc180efSBaptiste Daroussin </dt> 95*2bc180efSBaptiste Daroussin <dd> 96*2bc180efSBaptiste Daroussin Parse the value following an explicit <code>!!bool</code> tag. 97*2bc180efSBaptiste Daroussin 98*2bc180efSBaptiste Daroussin 99*2bc180efSBaptiste Daroussin <h3>Parameters:</h3> 100*2bc180efSBaptiste Daroussin <ul> 101*2bc180efSBaptiste Daroussin <li><span class="parameter">value</span> 102*2bc180efSBaptiste Daroussin token 103*2bc180efSBaptiste Daroussin </li> 104*2bc180efSBaptiste Daroussin </ul> 105*2bc180efSBaptiste Daroussin 106*2bc180efSBaptiste Daroussin <h3>Returns:</h3> 107*2bc180efSBaptiste Daroussin <ol> 108*2bc180efSBaptiste Daroussin 109*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="../modules/lyaml.explicit.html#bool">bool</a></span> 110*2bc180efSBaptiste Daroussin boolean equivalent, if a valid value was recognized 111*2bc180efSBaptiste Daroussin </ol> 112*2bc180efSBaptiste Daroussin <h3>Or</h3> 113*2bc180efSBaptiste Daroussin <ol> 114*2bc180efSBaptiste Daroussin 115*2bc180efSBaptiste Daroussin <span class="types"><span class="type">nil</span></span> 116*2bc180efSBaptiste Daroussin otherwise, nil 117*2bc180efSBaptiste Daroussin </ol> 118*2bc180efSBaptiste Daroussin 119*2bc180efSBaptiste Daroussin 120*2bc180efSBaptiste Daroussin 121*2bc180efSBaptiste Daroussin <h3>Usage:</h3> 122*2bc180efSBaptiste Daroussin <ul> 123*2bc180efSBaptiste Daroussin <pre class="example">maybe_bool = explicit.bool(tagarg)</pre> 124*2bc180efSBaptiste Daroussin </ul> 125*2bc180efSBaptiste Daroussin 126*2bc180efSBaptiste Daroussin</dd> 127*2bc180efSBaptiste Daroussin <dt> 128*2bc180efSBaptiste Daroussin <a name = "float"></a> 129*2bc180efSBaptiste Daroussin <strong>float (value)</strong> 130*2bc180efSBaptiste Daroussin </dt> 131*2bc180efSBaptiste Daroussin <dd> 132*2bc180efSBaptiste Daroussin Parse the value following an explicit <code>!!float</code> tag. 133*2bc180efSBaptiste Daroussin 134*2bc180efSBaptiste Daroussin 135*2bc180efSBaptiste Daroussin <h3>Parameters:</h3> 136*2bc180efSBaptiste Daroussin <ul> 137*2bc180efSBaptiste Daroussin <li><span class="parameter">value</span> 138*2bc180efSBaptiste Daroussin token 139*2bc180efSBaptiste Daroussin </li> 140*2bc180efSBaptiste Daroussin </ul> 141*2bc180efSBaptiste Daroussin 142*2bc180efSBaptiste Daroussin <h3>Returns:</h3> 143*2bc180efSBaptiste Daroussin <ol> 144*2bc180efSBaptiste Daroussin 145*2bc180efSBaptiste Daroussin <span class="types"><span class="type">number</span></span> 146*2bc180efSBaptiste Daroussin float equivalent, if a valid value was recognized 147*2bc180efSBaptiste Daroussin </ol> 148*2bc180efSBaptiste Daroussin <h3>Or</h3> 149*2bc180efSBaptiste Daroussin <ol> 150*2bc180efSBaptiste Daroussin 151*2bc180efSBaptiste Daroussin <span class="types"><span class="type">nil</span></span> 152*2bc180efSBaptiste Daroussin otherwise, nil 153*2bc180efSBaptiste Daroussin </ol> 154*2bc180efSBaptiste Daroussin 155*2bc180efSBaptiste Daroussin 156*2bc180efSBaptiste Daroussin 157*2bc180efSBaptiste Daroussin <h3>Usage:</h3> 158*2bc180efSBaptiste Daroussin <ul> 159*2bc180efSBaptiste Daroussin <pre class="example">maybe_float = explicit.float(tagarg)</pre> 160*2bc180efSBaptiste Daroussin </ul> 161*2bc180efSBaptiste Daroussin 162*2bc180efSBaptiste Daroussin</dd> 163*2bc180efSBaptiste Daroussin <dt> 164*2bc180efSBaptiste Daroussin <a name = "int"></a> 165*2bc180efSBaptiste Daroussin <strong>int (value)</strong> 166*2bc180efSBaptiste Daroussin </dt> 167*2bc180efSBaptiste Daroussin <dd> 168*2bc180efSBaptiste Daroussin Parse the value following an explicit <code>!!int</code> tag. 169*2bc180efSBaptiste Daroussin 170*2bc180efSBaptiste Daroussin 171*2bc180efSBaptiste Daroussin <h3>Parameters:</h3> 172*2bc180efSBaptiste Daroussin <ul> 173*2bc180efSBaptiste Daroussin <li><span class="parameter">value</span> 174*2bc180efSBaptiste Daroussin token 175*2bc180efSBaptiste Daroussin </li> 176*2bc180efSBaptiste Daroussin </ul> 177*2bc180efSBaptiste Daroussin 178*2bc180efSBaptiste Daroussin <h3>Returns:</h3> 179*2bc180efSBaptiste Daroussin <ol> 180*2bc180efSBaptiste Daroussin 181*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="../modules/lyaml.explicit.html#int">int</a></span> 182*2bc180efSBaptiste Daroussin integer equivalent, if a valid value was recognized 183*2bc180efSBaptiste Daroussin </ol> 184*2bc180efSBaptiste Daroussin <h3>Or</h3> 185*2bc180efSBaptiste Daroussin <ol> 186*2bc180efSBaptiste Daroussin 187*2bc180efSBaptiste Daroussin <span class="types"><span class="type">nil</span></span> 188*2bc180efSBaptiste Daroussin otherwise, nil 189*2bc180efSBaptiste Daroussin </ol> 190*2bc180efSBaptiste Daroussin 191*2bc180efSBaptiste Daroussin 192*2bc180efSBaptiste Daroussin 193*2bc180efSBaptiste Daroussin <h3>Usage:</h3> 194*2bc180efSBaptiste Daroussin <ul> 195*2bc180efSBaptiste Daroussin <pre class="example">maybe_int = explicit.int(tagarg)</pre> 196*2bc180efSBaptiste Daroussin </ul> 197*2bc180efSBaptiste Daroussin 198*2bc180efSBaptiste Daroussin</dd> 199*2bc180efSBaptiste Daroussin <dt> 200*2bc180efSBaptiste Daroussin <a name = "null"></a> 201*2bc180efSBaptiste Daroussin <strong>null ()</strong> 202*2bc180efSBaptiste Daroussin </dt> 203*2bc180efSBaptiste Daroussin <dd> 204*2bc180efSBaptiste Daroussin Parse an explicit <code>!!null</code> tag. 205*2bc180efSBaptiste Daroussin 206*2bc180efSBaptiste Daroussin 207*2bc180efSBaptiste Daroussin 208*2bc180efSBaptiste Daroussin <h3>Returns:</h3> 209*2bc180efSBaptiste Daroussin <ol> 210*2bc180efSBaptiste Daroussin 211*2bc180efSBaptiste Daroussin <span class="types"><span class="type">lyaml.null</span></span> 212*2bc180efSBaptiste Daroussin 213*2bc180efSBaptiste Daroussin 214*2bc180efSBaptiste Daroussin 215*2bc180efSBaptiste Daroussin </ol> 216*2bc180efSBaptiste Daroussin 217*2bc180efSBaptiste Daroussin 218*2bc180efSBaptiste Daroussin 219*2bc180efSBaptiste Daroussin <h3>Usage:</h3> 220*2bc180efSBaptiste Daroussin <ul> 221*2bc180efSBaptiste Daroussin <pre class="example">null = explicit.null(tagarg)</pre> 222*2bc180efSBaptiste Daroussin </ul> 223*2bc180efSBaptiste Daroussin 224*2bc180efSBaptiste Daroussin</dd> 225*2bc180efSBaptiste Daroussin <dt> 226*2bc180efSBaptiste Daroussin <a name = "str"></a> 227*2bc180efSBaptiste Daroussin <strong>str (value)</strong> 228*2bc180efSBaptiste Daroussin </dt> 229*2bc180efSBaptiste Daroussin <dd> 230*2bc180efSBaptiste Daroussin Parse the value following an explicit <code>!!str</code> tag. 231*2bc180efSBaptiste Daroussin 232*2bc180efSBaptiste Daroussin 233*2bc180efSBaptiste Daroussin <h3>Parameters:</h3> 234*2bc180efSBaptiste Daroussin <ul> 235*2bc180efSBaptiste Daroussin <li><span class="parameter">value</span> 236*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 237*2bc180efSBaptiste Daroussin token 238*2bc180efSBaptiste Daroussin </li> 239*2bc180efSBaptiste Daroussin </ul> 240*2bc180efSBaptiste Daroussin 241*2bc180efSBaptiste Daroussin <h3>Returns:</h3> 242*2bc180efSBaptiste Daroussin <ol> 243*2bc180efSBaptiste Daroussin 244*2bc180efSBaptiste Daroussin <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 245*2bc180efSBaptiste Daroussin <em>value</em> which was a string already 246*2bc180efSBaptiste Daroussin </ol> 247*2bc180efSBaptiste Daroussin 248*2bc180efSBaptiste Daroussin 249*2bc180efSBaptiste Daroussin 250*2bc180efSBaptiste Daroussin <h3>Usage:</h3> 251*2bc180efSBaptiste Daroussin <ul> 252*2bc180efSBaptiste Daroussin <pre class="example">tagarg = explicit.str(tagarg)</pre> 253*2bc180efSBaptiste Daroussin </ul> 254*2bc180efSBaptiste Daroussin 255*2bc180efSBaptiste Daroussin</dd> 256*2bc180efSBaptiste Daroussin</dl> 257*2bc180efSBaptiste Daroussin 258*2bc180efSBaptiste Daroussin 259*2bc180efSBaptiste Daroussin</div> <!-- id="content" --> 260*2bc180efSBaptiste Daroussin</div> <!-- id="main" --> 261*2bc180efSBaptiste Daroussin<div id="about"> 262*2bc180efSBaptiste Daroussin<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> 263*2bc180efSBaptiste Daroussin<i style="float:right;">Last updated 2022-10-22 17:12:03 </i> 264*2bc180efSBaptiste Daroussin</div> <!-- id="about" --> 265*2bc180efSBaptiste Daroussin</div> <!-- id="container" --> 266*2bc180efSBaptiste Daroussin</body> 267*2bc180efSBaptiste Daroussin</html> 268