git.m6w6.name Git - awesomized/ext-ion/blob - docs/v0.0/ion/Reader/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/Reader/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/Reader/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/Reader">
  41                                                         Reader
  42                                                 </a>
  43                                                 <ul>
  44                                                         <li>
  45
  46                                                         &circlearrowright; <strong><a href="./ion/Reader/Options">Options</a></strong>
  47
  48
  49                                                         <ul>
  50
  51                                                                 <li>
  52                                                                         &rdsh; <a href="./ion/Reader/Options/__construct">Options::__construct</a>
  53
  54                                                                 </li>
  55
  56                                                         </ul>
  57
  58
  59                                                 </ul>
  60
  61                                                 <li>&ldsh; <a href="./ion/Reader/Buffer">Buffer</a></li>
  62
  63                                                 <li>&ldsh; <a href="./ion/Reader/Reader">Reader</a></li>
  64
  65                                                 <li>&ldsh; <a href="./ion/Reader/Stream">Stream</a></li>
  66
  67                                                 <li>&ldsh; <a href="./ion/Reader/countAnnotations">Reader::countAnnotations</a></li>
  68
  69                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotation">Reader::getAnnotation</a></li>
  70
  71                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol</a></li>
  72
  73                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols</a></li>
  74
  75                                                 <li>&ldsh; <a href="./ion/Reader/getAnnotations">Reader::getAnnotations</a></li>
  76
  77                                                 <li>&ldsh; <a href="./ion/Reader/getDepth">Reader::getDepth</a></li>
  78
  79                                                 <li>&ldsh; <a href="./ion/Reader/getFieldName">Reader::getFieldName</a></li>
  80
  81                                                 <li>&ldsh; <a href="./ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol</a></li>
  82
  83                                                 <li>&ldsh; <a href="./ion/Reader/getPosition">Reader::getPosition</a></li>
  84
  85                                                 <li>&ldsh; <a href="./ion/Reader/getType">Reader::getType</a></li>
  86
  87                                                 <li>&ldsh; <a href="./ion/Reader/getValueLength">Reader::getValueLength</a></li>
  88
  89                                                 <li>&ldsh; <a href="./ion/Reader/getValueOffset">Reader::getValueOffset</a></li>
  90
  91                                                 <li>&ldsh; <a href="./ion/Reader/hasAnnotation">Reader::hasAnnotation</a></li>
  92
  93                                                 <li>&ldsh; <a href="./ion/Reader/hasAnnotations">Reader::hasAnnotations</a></li>
  94
  95                                                 <li>&ldsh; <a href="./ion/Reader/isInStruct">Reader::isInStruct</a></li>
  96
  97                                                 <li>&ldsh; <a href="./ion/Reader/isNull">Reader::isNull</a></li>
  98
  99                                                 <li>&ldsh; <a href="./ion/Reader/readBool">Reader::readBool</a></li>
 100
 101                                                 <li>&ldsh; <a href="./ion/Reader/readDecimal">Reader::readDecimal</a></li>
 102
 103                                                 <li>&ldsh; <a href="./ion/Reader/readFloat">Reader::readFloat</a></li>
 104
 105                                                 <li>&ldsh; <a href="./ion/Reader/readInt">Reader::readInt</a></li>
 106
 107                                                 <li>&ldsh; <a href="./ion/Reader/readLob">Reader::readLob</a></li>
 108
 109                                                 <li>&ldsh; <a href="./ion/Reader/readLobPart">Reader::readLobPart</a></li>
 110
 111                                                 <li>&ldsh; <a href="./ion/Reader/readNull">Reader::readNull</a></li>
 112
 113                                                 <li>&ldsh; <a href="./ion/Reader/readString">Reader::readString</a></li>
 114
 115                                                 <li>&ldsh; <a href="./ion/Reader/readStringPart">Reader::readStringPart</a></li>
 116
 117                                                 <li>&ldsh; <a href="./ion/Reader/readSymbol">Reader::readSymbol</a></li>
 118
 119                                                 <li>&ldsh; <a href="./ion/Reader/readTimestamp">Reader::readTimestamp</a></li>
 120
 121                                                 <li>&ldsh; <a href="./ion/Reader/seek">Reader::seek</a></li>
 122
 123                                         </ul>
 124
 125                                 </li>
 126                         </ul>
 127
 128                 </li>
 129         </ul>
 130 </div>
 131
 132 <h1>class ion\Reader\Options</h1>
 133 <p>Reader options.</p>
 134 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
 135 <p>None.</p>
 136 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
 137 <ul>
 138 <li>public ?ion\Catalog $catalog<br />
 139 ION catalog to use for symbol lookup.</li>
 140 <li>public ?ion\Decimal\Context $decimalContext<br />
 141 Decimal context to use.</li>
 142 <li>public ?Closure $onContextChange<br />
 143 Callback as function(\ion\Reader):void called upon local symbol table context change.</li>
 144 <li>public bool $returnSystemValues<br />
 145 Whether to return otherwise hidden system values.</li>
 146 <li>public int $maxContainerDepth<br />
 147 The maximum depth of nested containers.</li>
 148 <li>public int $maxAnnotations<br />
 149 The maximum number of annotations allowed on a single value.</li>
 150 <li>public int $annotationBufferSize<br />
 151 The maximum number of bytes of all annotations on a single value.</li>
 152 <li>public int $tempBufferSize<br />
 153 The maximum number of bytes of a symbol/value/chunk.</li>
 154 <li>public bool $skipCharacterValidation<br />
 155 Whether to skip UTF-8 validation.</li>
 156 </ul>
 157
 158
 159
 160 <h2 id="Functions:">Functions:</h2>
 161 <ul>
 162
 163         <li>
 164                 <h3><a href="ion/Reader/Options/__construct">Options::__construct</a></h3>
 165
 166                 <p>void ion\Reader\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [?Closure $onContextChange = NULL, [bool $returnSystemValues = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $annotationBufferSize = 16384, [int $tempBufferSize = 16384, [bool $skipCharacterValidation = false]]]]]]]]])</p>
 167         </li>
 168
 169 </ul>
 170
 171
 172                         <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
 173                         <script>
 174                                 var disqus_shortname = 'mdref';
 175                                 var disqus_identifier = 'ion/Reader/Options';
 176                         </script>
 177
 178                         <footer>
 179
 180 <ul>
 181         <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
 182 </a></li>
 183         <li><a href="LICENSE">&copy; 2013-2022          All rights reserved.</a></li>
 184         <li>
 185 </li>
 186 </ul>
 187
 188                         </footer>
 189
 190                         <script src="index.js"></script>
 191
 192                 </div>
 193         </body>
 194 </html>