doc/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.protocol.html">luci.http.protocol</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.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.jsonc.html">luci.jsonc</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  99         </li>
 100
 101         <li>
 102                 <a href="../modules/nixio.html">nixio</a>
 103         </li>
 104
 105         <li>
 106                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 107         </li>
 108
 109         <li>
 110                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 111         </li>
 112
 113         <li>
 114                 <a href="../modules/nixio.File.html">nixio.File</a>
 115         </li>
 116
 117         <li>
 118                 <a href="../modules/nixio.README.html">nixio.README</a>
 119         </li>
 120
 121         <li>
 122                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 123         </li>
 124
 125         <li>
 126                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 127         </li>
 128
 129         <li>
 130                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 131         </li>
 132
 133         <li>
 134                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 135         </li>
 136
 137         <li><strong>nixio.bin</strong></li>
 138
 139         <li>
 140                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 149         </li>
 150
 151 </ul>
 152
 153
 154
 155 <!-- File list -->
 156
 157
 158
 159
 160
 161
 162
 163 </div><!-- id="navigation" -->
 164
 165 <div id="content">
 166
 167 <h1>Class <code>nixio.bin</code></h1>
 168
 169 <p>
 170  Binary operations and conversion.</p>
 171
 172
 173
 174
 175
 176
 177
 178 <h2>Functions</h2>
 179 <table class="function_list">
 180
 181         <tr>
 182         <td class="name" nowrap><a href="#b64decode">b64decode</a>&nbsp;(buffer)</td>
 183         <td class="summary">
 184  Base64 decode a given buffer.</td>
 185         </tr>
 186
 187         <tr>
 188         <td class="name" nowrap><a href="#b64encode">b64encode</a>&nbsp;(buffer)</td>
 189         <td class="summary">
 190  Base64 encode a given buffer.</td>
 191         </tr>
 192
 193         <tr>
 194         <td class="name" nowrap><a href="#crc32">crc32</a>&nbsp;(buffer, initial)</td>
 195         <td class="summary">
 196  Calculate the CRC32 value of a buffer.</td>
 197         </tr>
 198
 199         <tr>
 200         <td class="name" nowrap><a href="#hexlify">hexlify</a>&nbsp;(buffer)</td>
 201         <td class="summary">
 202  Return a hexadecimal ASCII represantation of the content of a buffer.</td>
 203         </tr>
 204
 205         <tr>
 206         <td class="name" nowrap><a href="#unhexlify">unhexlify</a>&nbsp;(hexvalue)</td>
 207         <td class="summary">
 208  Return a binary buffer from a hexadecimal ASCII representation.</td>
 209         </tr>
 210
 211 </table>
 212
 213
 214
 215
 216
 217
 218 <br/>
 219 <br/>
 220
 221
 222 <h2><a name="functions"></a>Functions</h2>
 223 <dl class="function">
 224
 225
 226
 227 <dt><a name="b64decode"></a><strong>b64decode</strong>&nbsp;(buffer)</dt>
 228 <dd>
 229
 230  Base64 decode a given buffer.
 231
 232
 233 <h3>Parameters</h3>
 234 <ul>
 235
 236         <li>
 237           buffer: Base 64 Encoded data
 238         </li>
 239
 240 </ul>
 241
 242
 243
 244
 245
 246
 247 <h3>Return value:</h3>
 248 binary data
 249
 250
 251
 252 </dd>
 253
 254
 255
 256
 257 <dt><a name="b64encode"></a><strong>b64encode</strong>&nbsp;(buffer)</dt>
 258 <dd>
 259
 260  Base64 encode a given buffer.
 261
 262
 263 <h3>Parameters</h3>
 264 <ul>
 265
 266         <li>
 267           buffer: Buffer
 268         </li>
 269
 270 </ul>
 271
 272
 273
 274
 275
 276
 277 <h3>Return value:</h3>
 278 base64 encoded buffer
 279
 280
 281
 282 </dd>
 283
 284
 285
 286
 287 <dt><a name="crc32"></a><strong>crc32</strong>&nbsp;(buffer, initial)</dt>
 288 <dd>
 289
 290  Calculate the CRC32 value of a buffer.
 291
 292
 293 <h3>Parameters</h3>
 294 <ul>
 295
 296         <li>
 297           buffer: Buffer
 298         </li>
 299
 300         <li>
 301           initial: Initial CRC32 value (optional)
 302         </li>
 303
 304 </ul>
 305
 306
 307
 308
 309
 310
 311 <h3>Return value:</h3>
 312 crc32 value
 313
 314
 315
 316 </dd>
 317
 318
 319
 320
 321 <dt><a name="hexlify"></a><strong>hexlify</strong>&nbsp;(buffer)</dt>
 322 <dd>
 323
 324  Return a hexadecimal ASCII represantation of the content of a buffer.
 325
 326
 327 <h3>Parameters</h3>
 328 <ul>
 329
 330         <li>
 331           buffer: Buffer
 332         </li>
 333
 334 </ul>
 335
 336
 337
 338
 339
 340
 341 <h3>Return value:</h3>
 342 representation using characters [0-9a-f]
 343
 344
 345
 346 </dd>
 347
 348
 349
 350
 351 <dt><a name="unhexlify"></a><strong>unhexlify</strong>&nbsp;(hexvalue)</dt>
 352 <dd>
 353
 354  Return a binary buffer from a hexadecimal ASCII representation.
 355
 356
 357 <h3>Parameters</h3>
 358 <ul>
 359
 360         <li>
 361           hexvalue: representation using characters [0-9a-f]
 362         </li>
 363
 364 </ul>
 365
 366
 367
 368
 369
 370
 371 <h3>Return value:</h3>
 372 binary data
 373
 374
 375
 376 </dd>
 377
 378
 379 </dl>
 380
 381
 382
 383
 384
 385 </div> <!-- id="content" -->
 386
 387 </div> <!-- id="main" -->
 388
 389 <div id="about">
 390         <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>
 391 </div> <!-- id="about" -->
 392
 393 </div> <!-- id="container" -->
 394 </body>
 395 </html>