basic API docs
[awesomized/ext-ion] / docs / html / ion / Reader / Reader.html
1 <!doctype html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <title>
6 Reader -
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/Reader/Reader">
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/Reader/Reader">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/Reader">Reader</a></strong>
47
48
49
50 </ul>
51
52 <li>&ldsh; <a href="./ion/Reader/Buffer">Buffer</a></li>
53
54 <li>&ldsh; <a href="./ion/Reader/Options">Options</a></li>
55
56 <li>&ldsh; <a href="./ion/Reader/Stream">Stream</a></li>
57
58 <li>&ldsh; <a href="./ion/Reader/countAnnotations">Reader::countAnnotations</a></li>
59
60 <li>&ldsh; <a href="./ion/Reader/getAnnotation">Reader::getAnnotation</a></li>
61
62 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol</a></li>
63
64 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols</a></li>
65
66 <li>&ldsh; <a href="./ion/Reader/getAnnotations">Reader::getAnnotations</a></li>
67
68 <li>&ldsh; <a href="./ion/Reader/getDepth">Reader::getDepth</a></li>
69
70 <li>&ldsh; <a href="./ion/Reader/getFieldName">Reader::getFieldName</a></li>
71
72 <li>&ldsh; <a href="./ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol</a></li>
73
74 <li>&ldsh; <a href="./ion/Reader/getPosition">Reader::getPosition</a></li>
75
76 <li>&ldsh; <a href="./ion/Reader/getType">Reader::getType</a></li>
77
78 <li>&ldsh; <a href="./ion/Reader/getValueLength">Reader::getValueLength</a></li>
79
80 <li>&ldsh; <a href="./ion/Reader/getValueOffset">Reader::getValueOffset</a></li>
81
82 <li>&ldsh; <a href="./ion/Reader/hasAnnotation">Reader::hasAnnotation</a></li>
83
84 <li>&ldsh; <a href="./ion/Reader/hasAnnotations">Reader::hasAnnotations</a></li>
85
86 <li>&ldsh; <a href="./ion/Reader/isInStruct">Reader::isInStruct</a></li>
87
88 <li>&ldsh; <a href="./ion/Reader/isNull">Reader::isNull</a></li>
89
90 <li>&ldsh; <a href="./ion/Reader/readBool">Reader::readBool</a></li>
91
92 <li>&ldsh; <a href="./ion/Reader/readDecimal">Reader::readDecimal</a></li>
93
94 <li>&ldsh; <a href="./ion/Reader/readFloat">Reader::readFloat</a></li>
95
96 <li>&ldsh; <a href="./ion/Reader/readInt">Reader::readInt</a></li>
97
98 <li>&ldsh; <a href="./ion/Reader/readLob">Reader::readLob</a></li>
99
100 <li>&ldsh; <a href="./ion/Reader/readLobPart">Reader::readLobPart</a></li>
101
102 <li>&ldsh; <a href="./ion/Reader/readNull">Reader::readNull</a></li>
103
104 <li>&ldsh; <a href="./ion/Reader/readString">Reader::readString</a></li>
105
106 <li>&ldsh; <a href="./ion/Reader/readStringPart">Reader::readStringPart</a></li>
107
108 <li>&ldsh; <a href="./ion/Reader/readSymbol">Reader::readSymbol</a></li>
109
110 <li>&ldsh; <a href="./ion/Reader/readTimestamp">Reader::readTimestamp</a></li>
111
112 <li>&ldsh; <a href="./ion/Reader/seek">Reader::seek</a></li>
113
114 </ul>
115
116 </li>
117 </ul>
118
119 </li>
120 </ul>
121 </div>
122
123 <h1>abstract class ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader</h1>
124 <p>Base implementation of ION readers.</p>
125 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
126 <p>None.</p>
127 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
128 <ul>
129 <li>public ?ion\Reader\Options $options<br />
130 Reader options.</li>
131 </ul>
132
133
134
135
136 <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
137 <script>
138 var disqus_shortname = 'mdref';
139 var disqus_identifier = 'ion/Reader/Reader';
140 </script>
141
142 <footer>
143
144 <ul>
145 <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
146 </a></li>
147 <li><a href="LICENSE">&copy; 2013-2022 All rights reserved.</a></li>
148 <li>
149 </li>
150 </ul>
151
152 </footer>
153
154 <script src="index.js"></script>
155
156 </div>
157 </body>
158 </html>