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><a href="../modules/lyaml.explicit.html">lyaml.explicit</a></li> 43 <li><a href="../modules/lyaml.functional.html">lyaml.functional</a></li> 44 <li><strong>lyaml.implicit</strong></li> 45</ul> 46 47</div> 48 49<div id="content"> 50 51<h1>Module <code>lyaml.implicit</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="#null">null (value)</a></td> 64 <td class="summary">Parse a null token to a null value.</td> 65 </tr> 66 <tr> 67 <td class="name" nowrap><a href="#bool">bool (value)</a></td> 68 <td class="summary">Parse a boolean token to the equivalent value.</td> 69 </tr> 70 <tr> 71 <td class="name" nowrap><a href="#binary">binary (value)</a></td> 72 <td class="summary">Parse a binary token, such as '0b1010_0111_0100_1010_1110'.</td> 73 </tr> 74 <tr> 75 <td class="name" nowrap><a href="#octal">octal (value)</a></td> 76 <td class="summary">Parse an octal token, such as '012345'.</td> 77 </tr> 78 <tr> 79 <td class="name" nowrap><a href="#decimal">decimal (value)</a></td> 80 <td class="summary">Parse a decimal token, such as '0' or '12345'.</td> 81 </tr> 82 <tr> 83 <td class="name" nowrap><a href="#hexadecimal">hexadecimal (value)</a></td> 84 <td class="summary">Parse a hexadecimal token, such as '0xdeadbeef'.</td> 85 </tr> 86 <tr> 87 <td class="name" nowrap><a href="#sexagesimal">sexagesimal (value)</a></td> 88 <td class="summary">Parse a sexagesimal token, such as '190:20:30'.</td> 89 </tr> 90 <tr> 91 <td class="name" nowrap><a href="#nan">nan (value)</a></td> 92 <td class="summary">Parse a <code>nan</code> token.</td> 93 </tr> 94 <tr> 95 <td class="name" nowrap><a href="#inf">inf (value)</a></td> 96 <td class="summary">Parse a signed <code>inf</code> token.</td> 97 </tr> 98 <tr> 99 <td class="name" nowrap><a href="#float">float (value)</a></td> 100 <td class="summary">Parse a floating point number token, such as '1e-3' or '-0.12'.</td> 101 </tr> 102 <tr> 103 <td class="name" nowrap><a href="#sexfloat">sexfloat (value)</a></td> 104 <td class="summary">Parse a sexagesimal float, such as '190:20:30.15'.</td> 105 </tr> 106</table> 107 108<br/> 109<br/> 110 111 112 <h2 class="section-header "><a name="Functions"></a>Functions</h2> 113 114 <dl class="function"> 115 <dt> 116 <a name = "null"></a> 117 <strong>null (value)</strong> 118 </dt> 119 <dd> 120 Parse a null token to a null value. 121 122 123 <h3>Parameters:</h3> 124 <ul> 125 <li><span class="parameter">value</span> 126 token 127 </li> 128 </ul> 129 130 <h3>Returns:</h3> 131 <ol> 132 133 lyaml.null, for an empty string or literal ~ 134 </ol> 135 <h3>Or</h3> 136 <ol> 137 138 nil otherwise, nil 139 </ol> 140 141 142 143 <h3>Usage:</h3> 144 <ul> 145 <pre class="example">maybe_null = implicit.null(token)</pre> 146 </ul> 147 148</dd> 149 <dt> 150 <a name = "bool"></a> 151 <strong>bool (value)</strong> 152 </dt> 153 <dd> 154 Parse a boolean token to the equivalent value. 155 Treats capilalized, lower and upper-cased variants of true/false, 156 yes/no or on/off tokens as boolean <code>true</code> and <code>false</code> values. 157 158 159 <h3>Parameters:</h3> 160 <ul> 161 <li><span class="parameter">value</span> 162 token 163 </li> 164 </ul> 165 166 <h3>Returns:</h3> 167 <ol> 168 169 <span class="types"><a class="type" href="../modules/lyaml.implicit.html#bool">bool</a></span> 170 if a valid boolean token was recognized 171 </ol> 172 <h3>Or</h3> 173 <ol> 174 175 <span class="types"><span class="type">nil</span></span> 176 otherwise, nil 177 </ol> 178 179 180 181 <h3>Usage:</h3> 182 <ul> 183 <pre class="example">maybe_bool = implicit.bool(token)</pre> 184 </ul> 185 186</dd> 187 <dt> 188 <a name = "binary"></a> 189 <strong>binary (value)</strong> 190 </dt> 191 <dd> 192 Parse a binary token, such as '0b1010_0111_0100_1010_1110'. 193 194 195 <h3>Parameters:</h3> 196 <ul> 197 <li><span class="parameter">value</span> 198 <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 199 token 200 </li> 201 </ul> 202 203 <h3>Returns:</h3> 204 <ol> 205 206 <span class="types"><span class="type">int</span></span> 207 integer equivalent, if a valid token was recognized 208 </ol> 209 <h3>Or</h3> 210 <ol> 211 212 <span class="types"><span class="type">nil</span></span> 213 otherwise, nil 214 </ol> 215 216 217 218 <h3>Usage:</h3> 219 <ul> 220 <pre class="example">maybe_int = implicit.binary(value)</pre> 221 </ul> 222 223</dd> 224 <dt> 225 <a name = "octal"></a> 226 <strong>octal (value)</strong> 227 </dt> 228 <dd> 229 Parse an octal token, such as '012345'. 230 231 232 <h3>Parameters:</h3> 233 <ul> 234 <li><span class="parameter">value</span> 235 <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 236 token 237 </li> 238 </ul> 239 240 <h3>Returns:</h3> 241 <ol> 242 243 <span class="types"><span class="type">int</span></span> 244 integer equivalent, if a valid token was recognized 245 </ol> 246 <h3>Or</h3> 247 <ol> 248 249 <span class="types"><span class="type">nil</span></span> 250 otherwise, nil 251 </ol> 252 253 254 255 <h3>Usage:</h3> 256 <ul> 257 <pre class="example">maybe_int = implicit.octal(value)</pre> 258 </ul> 259 260</dd> 261 <dt> 262 <a name = "decimal"></a> 263 <strong>decimal (value)</strong> 264 </dt> 265 <dd> 266 Parse a decimal token, such as '0' or '12345'. 267 268 269 <h3>Parameters:</h3> 270 <ul> 271 <li><span class="parameter">value</span> 272 <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 273 token 274 </li> 275 </ul> 276 277 <h3>Returns:</h3> 278 <ol> 279 280 <span class="types"><span class="type">int</span></span> 281 integer equivalent, if a valid token was recognized 282 </ol> 283 <h3>Or</h3> 284 <ol> 285 286 <span class="types"><span class="type">nil</span></span> 287 otherwise, nil 288 </ol> 289 290 291 292 <h3>Usage:</h3> 293 <ul> 294 <pre class="example">maybe_int = implicit.decimal(value)</pre> 295 </ul> 296 297</dd> 298 <dt> 299 <a name = "hexadecimal"></a> 300 <strong>hexadecimal (value)</strong> 301 </dt> 302 <dd> 303 Parse a hexadecimal token, such as '0xdeadbeef'. 304 305 306 <h3>Parameters:</h3> 307 <ul> 308 <li><span class="parameter">value</span> 309 <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 310 token 311 </li> 312 </ul> 313 314 <h3>Returns:</h3> 315 <ol> 316 317 <span class="types"><span class="type">int</span></span> 318 integer equivalent, if a valid token was recognized 319 </ol> 320 <h3>Or</h3> 321 <ol> 322 323 <span class="types"><span class="type">nil</span></span> 324 otherwise, nil 325 </ol> 326 327 328 329 <h3>Usage:</h3> 330 <ul> 331 <pre class="example">maybe_int = implicit.hexadecimal(value)</pre> 332 </ul> 333 334</dd> 335 <dt> 336 <a name = "sexagesimal"></a> 337 <strong>sexagesimal (value)</strong> 338 </dt> 339 <dd> 340 Parse a sexagesimal token, such as '190:20:30'. 341 Useful for times and angles. 342 343 344 <h3>Parameters:</h3> 345 <ul> 346 <li><span class="parameter">value</span> 347 <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 348 token 349 </li> 350 </ul> 351 352 <h3>Returns:</h3> 353 <ol> 354 355 <span class="types"><span class="type">int</span></span> 356 integer equivalent, if a valid token was recognized 357 </ol> 358 <h3>Or</h3> 359 <ol> 360 361 <span class="types"><span class="type">nil</span></span> 362 otherwise, nil 363 </ol> 364 365 366 367 <h3>Usage:</h3> 368 <ul> 369 <pre class="example">maybe_int = implicit.sexagesimal(value)</pre> 370 </ul> 371 372</dd> 373 <dt> 374 <a name = "nan"></a> 375 <strong>nan (value)</strong> 376 </dt> 377 <dd> 378 Parse a <code>nan</code> token. 379 380 381 <h3>Parameters:</h3> 382 <ul> 383 <li><span class="parameter">value</span> 384 <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 385 token 386 </li> 387 </ul> 388 389 <h3>Returns:</h3> 390 <ol> 391 392 <span class="types"><a class="type" href="../modules/lyaml.implicit.html#nan">nan</a></span> 393 not-a-number, if a valid token was recognized 394 </ol> 395 <h3>Or</h3> 396 <ol> 397 398 <span class="types"><span class="type">nil</span></span> 399 otherwise, nil 400 </ol> 401 402 403 404 <h3>Usage:</h3> 405 <ul> 406 <pre class="example">maybe_nan = implicit.nan(value)</pre> 407 </ul> 408 409</dd> 410 <dt> 411 <a name = "inf"></a> 412 <strong>inf (value)</strong> 413 </dt> 414 <dd> 415 Parse a signed <code>inf</code> token. 416 417 418 <h3>Parameters:</h3> 419 <ul> 420 <li><span class="parameter">value</span> 421 <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 422 token 423 </li> 424 </ul> 425 426 <h3>Returns:</h3> 427 <ol> 428 429 <span class="types"><span class="type">number</span></span> 430 plus/minus-infinity, if a valid token was recognized 431 </ol> 432 <h3>Or</h3> 433 <ol> 434 435 <span class="types"><span class="type">nil</span></span> 436 otherwise, nil 437 </ol> 438 439 440 441 <h3>Usage:</h3> 442 <ul> 443 <pre class="example">maybe_inf = implicit.inf(value)</pre> 444 </ul> 445 446</dd> 447 <dt> 448 <a name = "float"></a> 449 <strong>float (value)</strong> 450 </dt> 451 <dd> 452 Parse a floating point number token, such as '1e-3' or '-0.12'. 453 454 455 <h3>Parameters:</h3> 456 <ul> 457 <li><span class="parameter">value</span> 458 <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 459 token 460 </li> 461 </ul> 462 463 <h3>Returns:</h3> 464 <ol> 465 466 <span class="types"><span class="type">number</span></span> 467 float equivalent, if a valid token was recognized 468 </ol> 469 <h3>Or</h3> 470 <ol> 471 472 <span class="types"><span class="type">nil</span></span> 473 otherwise, nil 474 </ol> 475 476 477 478 <h3>Usage:</h3> 479 <ul> 480 <pre class="example">maybe_float = implicit.float(value)</pre> 481 </ul> 482 483</dd> 484 <dt> 485 <a name = "sexfloat"></a> 486 <strong>sexfloat (value)</strong> 487 </dt> 488 <dd> 489 Parse a sexagesimal float, such as '190:20:30.15'. 490 Useful for times and angles. 491 492 493 <h3>Parameters:</h3> 494 <ul> 495 <li><span class="parameter">value</span> 496 <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> 497 token 498 </li> 499 </ul> 500 501 <h3>Returns:</h3> 502 <ol> 503 504 <span class="types"><span class="type">number</span></span> 505 float equivalent, if a valid token was recognized 506 </ol> 507 <h3>Or</h3> 508 <ol> 509 510 <span class="types"><span class="type">nil</span></span> 511 otherwise, nil 512 </ol> 513 514 515 516 <h3>Usage:</h3> 517 <ul> 518 <pre class="example">maybe_float = implicit.sexfloat(value)</pre> 519 </ul> 520 521</dd> 522</dl> 523 524 525</div> <!-- id="content" --> 526</div> <!-- id="main" --> 527<div id="about"> 528<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> 529<i style="float:right;">Last updated 2022-10-22 17:12:03 </i> 530</div> <!-- id="about" --> 531</div> <!-- id="container" --> 532</body> 533</html> 534