git.m6w6.name Git - awesomized/ext-ion/blob - docs/html/ion/Writer.html

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         Writer -
   7                                                 mdref
   8                 </title>
   9                 <meta name="viewport" content="width=1200, initial-scale=0.5">
  10                                         <base href="/">
  11                         <meta http-equiv="Content-Location" content="/ion/Writer">
  12                         <link rel="stylesheet" href="index.css">
  13
  14                 <link href="https://fonts.googleapis.com/css?family=Inconsolata&amp;subset=latin-ext" rel="stylesheet">
  15                 <script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
  16                 <link rel="shortcut icon" href="/favicon.ico">
  17         </head>
  18         <body>
  19                 <div class="page">
  20
  21 <div class="sidebar">
  22
  23         <div class="edit">
  24                 <a href="./ion/Writer">Edit</a>
  25         </div>
  26
  27
  28         <ul>
  29                 <li>&lsh; <a href="./">Home</a>
  30
  31                         <ul>
  32                                 <li>
  33
  34                                         &uarr; <a href="./ion">
  35                                                         ion
  36                                                 </a>
  37                                                 <ul>
  38                                                         <li>
  39
  40                                                         &circlearrowright; <strong><a href="./ion/Writer">Writer</a></strong>
  41
  42
  43                                                         <ul>
  44
  45                                                                 <li>
  46                                                                         &rdsh; <a href="./ion/Writer/Buffer">Buffer</a>
  47
  48                                                                         <ul>
  49
  50                                                                                 <li>&rdsh; <a href="./ion/Writer/Buffer/Writer">Writer</a>
  51                                                                                 </li>
  52
  53                                                                         </ul>
  54
  55                                                                 </li>
  56
  57                                                                 <li>
  58                                                                         &rdsh; <a href="./ion/Writer/Options">Options</a>
  59
  60                                                                 </li>
  61
  62                                                                 <li>
  63                                                                         &rdsh; <a href="./ion/Writer/Stream">Stream</a>
  64
  65                                                                         <ul>
  66
  67                                                                                 <li>&rdsh; <a href="./ion/Writer/Stream/Writer">Writer</a>
  68                                                                                 </li>
  69
  70                                                                         </ul>
  71
  72                                                                 </li>
  73
  74                                                                 <li>
  75                                                                         &rdsh; <a href="./ion/Writer/Writer">Writer</a>
  76
  77                                                                 </li>
  78
  79                                                                 <li>
  80                                                                         &rdsh; <a href="./ion/Writer/appendLob">Writer::appendLob</a>
  81
  82                                                                 </li>
  83
  84                                                                 <li>
  85                                                                         &rdsh; <a href="./ion/Writer/finish">Writer::finish</a>
  86
  87                                                                 </li>
  88
  89                                                                 <li>
  90                                                                         &rdsh; <a href="./ion/Writer/finishContainer">Writer::finishContainer</a>
  91
  92                                                                 </li>
  93
  94                                                                 <li>
  95                                                                         &rdsh; <a href="./ion/Writer/finishLob">Writer::finishLob</a>
  96
  97                                                                 </li>
  98
  99                                                                 <li>
 100                                                                         &rdsh; <a href="./ion/Writer/flush">Writer::flush</a>
 101
 102                                                                 </li>
 103
 104                                                                 <li>
 105                                                                         &rdsh; <a href="./ion/Writer/getDepth">Writer::getDepth</a>
 106
 107                                                                 </li>
 108
 109                                                                 <li>
 110                                                                         &rdsh; <a href="./ion/Writer/startContainer">Writer::startContainer</a>
 111
 112                                                                 </li>
 113
 114                                                                 <li>
 115                                                                         &rdsh; <a href="./ion/Writer/startLob">Writer::startLob</a>
 116
 117                                                                 </li>
 118
 119                                                                 <li>
 120                                                                         &rdsh; <a href="./ion/Writer/writeAnnotation">Writer::writeAnnotation</a>
 121
 122                                                                 </li>
 123
 124                                                                 <li>
 125                                                                         &rdsh; <a href="./ion/Writer/writeBLob">Writer::writeBLob</a>
 126
 127                                                                 </li>
 128
 129                                                                 <li>
 130                                                                         &rdsh; <a href="./ion/Writer/writeBool">Writer::writeBool</a>
 131
 132                                                                 </li>
 133
 134                                                                 <li>
 135                                                                         &rdsh; <a href="./ion/Writer/writeCLob">Writer::writeCLob</a>
 136
 137                                                                 </li>
 138
 139                                                                 <li>
 140                                                                         &rdsh; <a href="./ion/Writer/writeDecimal">Writer::writeDecimal</a>
 141
 142                                                                 </li>
 143
 144                                                                 <li>
 145                                                                         &rdsh; <a href="./ion/Writer/writeFieldName">Writer::writeFieldName</a>
 146
 147                                                                 </li>
 148
 149                                                                 <li>
 150                                                                         &rdsh; <a href="./ion/Writer/writeFloat">Writer::writeFloat</a>
 151
 152                                                                 </li>
 153
 154                                                                 <li>
 155                                                                         &rdsh; <a href="./ion/Writer/writeInt">Writer::writeInt</a>
 156
 157                                                                 </li>
 158
 159                                                                 <li>
 160                                                                         &rdsh; <a href="./ion/Writer/writeNull">Writer::writeNull</a>
 161
 162                                                                 </li>
 163
 164                                                                 <li>
 165                                                                         &rdsh; <a href="./ion/Writer/writeString">Writer::writeString</a>
 166
 167                                                                 </li>
 168
 169                                                                 <li>
 170                                                                         &rdsh; <a href="./ion/Writer/writeSymbol">Writer::writeSymbol</a>
 171
 172                                                                 </li>
 173
 174                                                                 <li>
 175                                                                         &rdsh; <a href="./ion/Writer/writeTimestamp">Writer::writeTimestamp</a>
 176
 177                                                                 </li>
 178
 179                                                                 <li>
 180                                                                         &rdsh; <a href="./ion/Writer/writeTypedNull">Writer::writeTypedNull</a>
 181
 182                                                                 </li>
 183
 184                                                         </ul>
 185
 186
 187                                                 </ul>
 188
 189                                                 <li>&ldsh; <a href="./ion/Catalog">Catalog</a></li>
 190
 191                                                 <li>&ldsh; <a href="./ion/Decimal">Decimal</a></li>
 192
 193                                                 <li>&ldsh; <a href="./ion/Exception">Exception</a></li>
 194
 195                                                 <li>&ldsh; <a href="./ion/LOB">LOB</a></li>
 196
 197                                                 <li>&ldsh; <a href="./ion/Reader">Reader</a></li>
 198
 199                                                 <li>&ldsh; <a href="./ion/Serializer">Serializer</a></li>
 200
 201                                                 <li>&ldsh; <a href="./ion/Symbol">Symbol</a></li>
 202
 203                                                 <li>&ldsh; <a href="./ion/Timestamp">Timestamp</a></li>
 204
 205                                                 <li>&ldsh; <a href="./ion/Type">Type</a></li>
 206
 207                                                 <li>&ldsh; <a href="./ion/Unserializer">Unserializer</a></li>
 208
 209                                                 <li>&ldsh; <a href="./ion/serialize">serialize</a></li>
 210
 211                                                 <li>&ldsh; <a href="./ion/unserialize">unserialize</a></li>
 212
 213                                 </li>
 214                         </ul>
 215
 216                 </li>
 217         </ul>
 218 </div>
 219
 220 <h1>interface ion\Writer</h1>
 221 <p>ION writer API.</p>
 222 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
 223 <p>None.</p>
 224 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
 225 <p>None.</p>
 226
 227
 228
 229 <h2 id="Functions:">Functions:</h2>
 230 <ul>
 231
 232         <li>
 233                 <h3><a href="ion/Writer/appendLob">Writer::appendLob</a></h3>
 234
 235                 <p>void ion\Writer::appendLob(string $data)</p>
 236         </li>
 237
 238         <li>
 239                 <h3><a href="ion/Writer/finish">Writer::finish</a></h3>
 240
 241                 <p>int ion\Writer::finish()</p>
 242         </li>
 243
 244         <li>
 245                 <h3><a href="ion/Writer/finishContainer">Writer::finishContainer</a></h3>
 246
 247                 <p>void ion\Writer::finishContainer()</p>
 248         </li>
 249
 250         <li>
 251                 <h3><a href="ion/Writer/finishLob">Writer::finishLob</a></h3>
 252
 253                 <p>void ion\Writer::finishLob()</p>
 254         </li>
 255
 256         <li>
 257                 <h3><a href="ion/Writer/flush">Writer::flush</a></h3>
 258
 259                 <p>int ion\Writer::flush()</p>
 260         </li>
 261
 262         <li>
 263                 <h3><a href="ion/Writer/getDepth">Writer::getDepth</a></h3>
 264
 265                 <p>int ion\Writer::getDepth()</p>
 266         </li>
 267
 268         <li>
 269                 <h3><a href="ion/Writer/startContainer">Writer::startContainer</a></h3>
 270
 271                 <p>void ion\Writer::startContainer(ion\Type $type)</p>
 272         </li>
 273
 274         <li>
 275                 <h3><a href="ion/Writer/startLob">Writer::startLob</a></h3>
 276
 277                 <p>void ion\Writer::startLob(ion\Type $type)</p>
 278         </li>
 279
 280         <li>
 281                 <h3><a href="ion/Writer/writeAnnotation">Writer::writeAnnotation</a></h3>
 282
 283                 <p>void ion\Writer::writeAnnotation([ion\Symbol|string  ?&gt;...$annotation])</p>
 284         </li>
 285
 286         <li>
 287                 <h3><a href="ion/Writer/writeBLob">Writer::writeBLob</a></h3>
 288
 289                 <p>void ion\Writer::writeBLob(string $value)</p>
 290         </li>
 291
 292         <li>
 293                 <h3><a href="ion/Writer/writeBool">Writer::writeBool</a></h3>
 294
 295                 <p>void ion\Writer::writeBool(bool $value)</p>
 296         </li>
 297
 298         <li>
 299                 <h3><a href="ion/Writer/writeCLob">Writer::writeCLob</a></h3>
 300
 301                 <p>void ion\Writer::writeCLob(string $value)</p>
 302         </li>
 303
 304         <li>
 305                 <h3><a href="ion/Writer/writeDecimal">Writer::writeDecimal</a></h3>
 306
 307                 <p>void ion\Writer::writeDecimal(ion\Decimal|string $value)</p>
 308         </li>
 309
 310         <li>
 311                 <h3><a href="ion/Writer/writeFieldName">Writer::writeFieldName</a></h3>
 312
 313                 <p>void ion\Writer::writeFieldName(string $name)</p>
 314         </li>
 315
 316         <li>
 317                 <h3><a href="ion/Writer/writeFloat">Writer::writeFloat</a></h3>
 318
 319                 <p>void ion\Writer::writeFloat(float $value)</p>
 320         </li>
 321
 322         <li>
 323                 <h3><a href="ion/Writer/writeInt">Writer::writeInt</a></h3>
 324
 325                 <p>void ion\Writer::writeInt(string|int $value)</p>
 326         </li>
 327
 328         <li>
 329                 <h3><a href="ion/Writer/writeNull">Writer::writeNull</a></h3>
 330
 331                 <p>void ion\Writer::writeNull()</p>
 332         </li>
 333
 334         <li>
 335                 <h3><a href="ion/Writer/writeString">Writer::writeString</a></h3>
 336
 337                 <p>void ion\Writer::writeString(string $value)</p>
 338         </li>
 339
 340         <li>
 341                 <h3><a href="ion/Writer/writeSymbol">Writer::writeSymbol</a></h3>
 342
 343                 <p>void ion\Writer::writeSymbol(ion\Symbol|string $value)</p>
 344         </li>
 345
 346         <li>
 347                 <h3><a href="ion/Writer/writeTimestamp">Writer::writeTimestamp</a></h3>
 348
 349                 <p>void ion\Writer::writeTimestamp(ion\Timestamp|string $value)</p>
 350         </li>
 351
 352         <li>
 353                 <h3><a href="ion/Writer/writeTypedNull">Writer::writeTypedNull</a></h3>
 354
 355                 <p>void ion\Writer::writeTypedNull(ion\Type $type)</p>
 356         </li>
 357
 358 </ul>
 359
 360
 361 <h2 id="Namespaces,.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:</h2>
 362 <ul>
 363
 364         <li>
 365                 <h3><a href="ion/Writer/Buffer">Buffer</a></h3>
 366                 <p>ION buffer writer API.</p>
 367
 368                 <p>interface ion\Writer\Buffer implements ion\Writer</p>
 369         </li>
 370
 371         <li>
 372                 <h3><a href="ion/Writer/Options">Options</a></h3>
 373                 <p>ION writer options.</p>
 374
 375                 <p>class ion\Writer\Options</p>
 376         </li>
 377
 378         <li>
 379                 <h3><a href="ion/Writer/Stream">Stream</a></h3>
 380                 <p>ION stream writer API.</p>
 381
 382                 <p>interface ion\Writer\Stream implements ion\Writer</p>
 383         </li>
 384
 385         <li>
 386                 <h3><a href="ion/Writer/Writer">Writer</a></h3>
 387                 <p>Base implementation of common functionality of ION writers.</p>
 388
 389                 <p>abstract class ion\Writer\Writer implements ion\Writer</p>
 390         </li>
 391
 392 </ul>
 393
 394                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 395                         <script>
 396                                 var disqus_shortname = 'mdref';
 397                                 var disqus_identifier = 'ion/Writer';
 398                         </script>
 399
 400                         <footer>
 401
 402 <ul>
 403         <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
 404 </a></li>
 405         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 406         <li>
 407 </li>
 408 </ul>
 409
 410                         </footer>
 411
 412                         <script src="index.js"></script>
 413
 414                 </div>
 415         </body>
 416 </html>