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