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

   1 <!doctype html>
   2 <html>
   3         <head>
   4                 <meta charset="utf-8">
   5                 <title>
   6                                                         Options -
   7                                                 mdref
   8                 </title>
   9                 <meta name="viewport" content="width=1200, initial-scale=0.5">
  10                                         <base href="/v0.0/">
  11                         <meta http-equiv="Content-Location" content="/v0.0/ion/Writer/Options">
  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="/v0.0/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/Options">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                                         &uarr; <a href="./ion/Writer">
  41                                                         Writer
  42                                                 </a>
  43                                                 <ul>
  44                                                         <li>
  45
  46                                                         &circlearrowright; <strong><a href="./ion/Writer/Options">Options</a></strong>
  47
  48
  49                                                         <ul>
  50
  51                                                                 <li>
  52                                                                         &rdsh; <a href="./ion/Writer/Options/__construct">Options::__construct</a>
  53
  54                                                                 </li>
  55
  56                                                         </ul>
  57
  58
  59                                                 </ul>
  60
  61                                                 <li>&ldsh; <a href="./ion/Writer/Buffer">Buffer</a></li>
  62
  63                                                 <li>&ldsh; <a href="./ion/Writer/Stream">Stream</a></li>
  64
  65                                                 <li>&ldsh; <a href="./ion/Writer/Writer">Writer</a></li>
  66
  67                                                 <li>&ldsh; <a href="./ion/Writer/appendLob">Writer::appendLob</a></li>
  68
  69                                                 <li>&ldsh; <a href="./ion/Writer/finish">Writer::finish</a></li>
  70
  71                                                 <li>&ldsh; <a href="./ion/Writer/finishContainer">Writer::finishContainer</a></li>
  72
  73                                                 <li>&ldsh; <a href="./ion/Writer/finishLob">Writer::finishLob</a></li>
  74
  75                                                 <li>&ldsh; <a href="./ion/Writer/flush">Writer::flush</a></li>
  76
  77                                                 <li>&ldsh; <a href="./ion/Writer/getDepth">Writer::getDepth</a></li>
  78
  79                                                 <li>&ldsh; <a href="./ion/Writer/startContainer">Writer::startContainer</a></li>
  80
  81                                                 <li>&ldsh; <a href="./ion/Writer/startLob">Writer::startLob</a></li>
  82
  83                                                 <li>&ldsh; <a href="./ion/Writer/writeAnnotation">Writer::writeAnnotation</a></li>
  84
  85                                                 <li>&ldsh; <a href="./ion/Writer/writeBLob">Writer::writeBLob</a></li>
  86
  87                                                 <li>&ldsh; <a href="./ion/Writer/writeBool">Writer::writeBool</a></li>
  88
  89                                                 <li>&ldsh; <a href="./ion/Writer/writeCLob">Writer::writeCLob</a></li>
  90
  91                                                 <li>&ldsh; <a href="./ion/Writer/writeDecimal">Writer::writeDecimal</a></li>
  92
  93                                                 <li>&ldsh; <a href="./ion/Writer/writeFieldName">Writer::writeFieldName</a></li>
  94
  95                                                 <li>&ldsh; <a href="./ion/Writer/writeFloat">Writer::writeFloat</a></li>
  96
  97                                                 <li>&ldsh; <a href="./ion/Writer/writeInt">Writer::writeInt</a></li>
  98
  99                                                 <li>&ldsh; <a href="./ion/Writer/writeNull">Writer::writeNull</a></li>
 100
 101                                                 <li>&ldsh; <a href="./ion/Writer/writeString">Writer::writeString</a></li>
 102
 103                                                 <li>&ldsh; <a href="./ion/Writer/writeSymbol">Writer::writeSymbol</a></li>
 104
 105                                                 <li>&ldsh; <a href="./ion/Writer/writeTimestamp">Writer::writeTimestamp</a></li>
 106
 107                                                 <li>&ldsh; <a href="./ion/Writer/writeTypedNull">Writer::writeTypedNull</a></li>
 108
 109                                         </ul>
 110
 111                                 </li>
 112                         </ul>
 113
 114                 </li>
 115         </ul>
 116 </div>
 117
 118 <h1>class ion\Writer\Options</h1>
 119 <p>ION writer options.</p>
 120 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
 121 <p>None.</p>
 122 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
 123 <ul>
 124 <li>public ?ion\Catalog $catalog<br />
 125 ION catalog to use for symbol lookup.</li>
 126 <li>public ?ion\Decimal\Context $decimalContext<br />
 127 Decimal context to use.</li>
 128 <li>public bool $outputBinary<br />
 129 Whether to output binary ION.</li>
 130 <li>public bool $compactFloats<br />
 131 Whether to write doubles which fit in 32 bits as floats.</li>
 132 <li>public bool $escapeNonAscii<br />
 133 Whether to slash-escape all non ASCII bytes.</li>
 134 <li>public bool $prettyPrint<br />
 135 Whether to produce pretty-printed output.</li>
 136 <li>public bool $indentTabs<br />
 137 Whether to indent with tabs, when pretty-printing.</li>
 138 <li>public int $indentSize<br />
 139 The number of spaces to use for indentation instead of tabs, when pretty-printing.</li>
 140 <li>public bool $flushEveryValue<br />
 141 Whether to immediately flush every value written.</li>
 142 <li>public int $maxContainerDepth<br />
 143 Maximum depth of nested containers.</li>
 144 <li>public int $maxAnnotations<br />
 145 The maximum number of annotations allowed on a single value.</li>
 146 <li>public int $tempBufferSize<br />
 147 Temporary buffer size.</li>
 148 </ul>
 149
 150
 151
 152 <h2 id="Functions:">Functions:</h2>
 153 <ul>
 154
 155         <li>
 156                 <h3><a href="ion/Writer/Options/__construct">Options::__construct</a></h3>
 157                 <p>Create custom ION writer options.</p>
 158
 159                 <p>void ion\Writer\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [bool $outputBinary = false, [bool $compactFloats = false, [bool $escapeNonAscii = false, [bool $prettyPrint = false, [bool $indentTabs = true, [int $indentSize = 2, [bool $flushEveryValue = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $tempBufferSize = 16384]]]]]]]]]]]])</p>
 160         </li>
 161
 162 </ul>
 163
 164
 165                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 166                         <script>
 167                                 var disqus_shortname = 'mdref';
 168                                 var disqus_identifier = 'ion/Writer/Options';
 169                         </script>
 170
 171                         <footer>
 172
 173 <ul>
 174         <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
 175 </a></li>
 176         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 177         <li>
 178 </li>
 179 </ul>
 180
 181                         </footer>
 182
 183                         <script src="index.js"></script>
 184
 185                 </div>
 186         </body>
 187 </html>