documentation/api/modules/nixio.bin.html

   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 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  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 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.html">luci.http</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.date.html">luci.http.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.mime.html">luci.http.mime</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  59         </li>
  60
  61         <li>
  62                 <a href="../modules/luci.ip.html">luci.ip</a>
  63         </li>
  64
  65         <li>
  66                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  67         </li>
  68
  69         <li>
  70                 <a href="../modules/luci.json.html">luci.json</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.sys.html">luci.sys</a>
  99         </li>
 100
 101         <li>
 102                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 103         </li>
 104
 105         <li>
 106                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 107         </li>
 108
 109         <li>
 110                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 111         </li>
 112
 113         <li>
 114                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 115         </li>
 116
 117         <li>
 118                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 119         </li>
 120
 121         <li>
 122                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 123         </li>
 124
 125         <li>
 126                 <a href="../modules/luci.util.html">luci.util</a>
 127         </li>
 128
 129         <li>
 130                 <a href="../modules/nixio.html">nixio</a>
 131         </li>
 132
 133         <li>
 134                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 135         </li>
 136
 137         <li>
 138                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 139         </li>
 140
 141         <li>
 142                 <a href="../modules/nixio.File.html">nixio.File</a>
 143         </li>
 144
 145         <li>
 146                 <a href="../modules/nixio.README.html">nixio.README</a>
 147         </li>
 148
 149         <li>
 150                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 151         </li>
 152
 153         <li>
 154                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 155         </li>
 156
 157         <li>
 158                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 159         </li>
 160
 161         <li>
 162                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 163         </li>
 164
 165         <li><strong>nixio.bin</strong></li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 177         </li>
 178
 179 </ul>
 180
 181
 182
 183 <!-- File list -->
 184
 185
 186
 187
 188
 189
 190
 191 </div><!-- id="navigation" -->
 192
 193 <div id="content">
 194
 195 <h1>Class <code>nixio.bin</code></h1>
 196
 197 <p>
 198  Binary operations and conversion.</p>
 199
 200
 201
 202
 203
 204
 205
 206 <h2>Functions</h2>
 207 <table class="function_list">
 208
 209         <tr>
 210         <td class="name" nowrap><a href="#b64decode">b64decode</a>&nbsp;(buffer)</td>
 211         <td class="summary">
 212  Base64 decode a given buffer.</td>
 213         </tr>
 214
 215         <tr>
 216         <td class="name" nowrap><a href="#b64encode">b64encode</a>&nbsp;(buffer)</td>
 217         <td class="summary">
 218  Base64 encode a given buffer.</td>
 219         </tr>
 220
 221         <tr>
 222         <td class="name" nowrap><a href="#crc32">crc32</a>&nbsp;(buffer, initial)</td>
 223         <td class="summary">
 224  Calculate the CRC32 value of a buffer.</td>
 225         </tr>
 226
 227         <tr>
 228         <td class="name" nowrap><a href="#hexlify">hexlify</a>&nbsp;(buffer)</td>
 229         <td class="summary">
 230  Return a hexadecimal ASCII represantation of the content of a buffer.</td>
 231         </tr>
 232
 233         <tr>
 234         <td class="name" nowrap><a href="#unhexlify">unhexlify</a>&nbsp;(hexvalue)</td>
 235         <td class="summary">
 236  Return a binary buffer from a hexadecimal ASCII representation.</td>
 237         </tr>
 238
 239 </table>
 240
 241
 242
 243
 244
 245
 246 <br/>
 247 <br/>
 248
 249
 250 <h2><a name="functions"></a>Functions</h2>
 251 <dl class="function">
 252
 253
 254
 255 <dt><a name="b64decode"></a><strong>b64decode</strong>&nbsp;(buffer)</dt>
 256 <dd>
 257
 258  Base64 decode a given buffer.
 259
 260
 261 <h3>Parameters</h3>
 262 <ul>
 263
 264         <li>
 265           buffer: Base 64 Encoded data
 266         </li>
 267
 268 </ul>
 269
 270
 271
 272
 273
 274
 275 <h3>Return value:</h3>
 276 binary data
 277
 278
 279
 280 </dd>
 281
 282
 283
 284
 285 <dt><a name="b64encode"></a><strong>b64encode</strong>&nbsp;(buffer)</dt>
 286 <dd>
 287
 288  Base64 encode a given buffer.
 289
 290
 291 <h3>Parameters</h3>
 292 <ul>
 293
 294         <li>
 295           buffer: Buffer
 296         </li>
 297
 298 </ul>
 299
 300
 301
 302
 303
 304
 305 <h3>Return value:</h3>
 306 base64 encoded buffer
 307
 308
 309
 310 </dd>
 311
 312
 313
 314
 315 <dt><a name="crc32"></a><strong>crc32</strong>&nbsp;(buffer, initial)</dt>
 316 <dd>
 317
 318  Calculate the CRC32 value of a buffer.
 319
 320
 321 <h3>Parameters</h3>
 322 <ul>
 323
 324         <li>
 325           buffer: Buffer
 326         </li>
 327
 328         <li>
 329           initial: Initial CRC32 value (optional)
 330         </li>
 331
 332 </ul>
 333
 334
 335
 336
 337
 338
 339 <h3>Return value:</h3>
 340 crc32 value
 341
 342
 343
 344 </dd>
 345
 346
 347
 348
 349 <dt><a name="hexlify"></a><strong>hexlify</strong>&nbsp;(buffer)</dt>
 350 <dd>
 351
 352  Return a hexadecimal ASCII represantation of the content of a buffer.
 353
 354
 355 <h3>Parameters</h3>
 356 <ul>
 357
 358         <li>
 359           buffer: Buffer
 360         </li>
 361
 362 </ul>
 363
 364
 365
 366
 367
 368
 369 <h3>Return value:</h3>
 370 representation using characters [0-9a-f]
 371
 372
 373
 374 </dd>
 375
 376
 377
 378
 379 <dt><a name="unhexlify"></a><strong>unhexlify</strong>&nbsp;(hexvalue)</dt>
 380 <dd>
 381
 382  Return a binary buffer from a hexadecimal ASCII representation.
 383
 384
 385 <h3>Parameters</h3>
 386 <ul>
 387
 388         <li>
 389           hexvalue: representation using characters [0-9a-f]
 390         </li>
 391
 392 </ul>
 393
 394
 395
 396
 397
 398
 399 <h3>Return value:</h3>
 400 binary data
 401
 402
 403
 404 </dd>
 405
 406
 407 </dl>
 408
 409
 410
 411
 412
 413 </div> <!-- id="content" -->
 414
 415 </div> <!-- id="main" -->
 416
 417 <div id="about">
 418         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
 419 </div> <!-- id="about" -->
 420
 421 </div> <!-- id="container" -->
 422 </body>
 423 </html>