docs: attempt to fix gh-pages
[awesomized/ext-ion] / docs / v0.0 / ion / Reader / Stream.html
1 <!doctype html>
2 <html>
3 <head>
4 <meta charset="utf-8">
5 <title>
6 Stream -
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/Stream">
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/Stream">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/Stream">Stream</a></strong>
47
48
49 <ul>
50
51 <li>
52 &rdsh; <a href="./ion/Reader/Stream/Reader">Reader</a>
53
54 </li>
55
56 <li>
57 &rdsh; <a href="./ion/Reader/Stream/getStream">Stream::getStream</a>
58
59 </li>
60
61 <li>
62 &rdsh; <a href="./ion/Reader/Stream/resetStream">Stream::resetStream</a>
63
64 </li>
65
66 <li>
67 &rdsh; <a href="./ion/Reader/Stream/resetStreamWithLength">Stream::resetStreamWithLength</a>
68
69 </li>
70
71 </ul>
72
73
74 </ul>
75
76 <li>&ldsh; <a href="./ion/Reader/Buffer">Buffer</a></li>
77
78 <li>&ldsh; <a href="./ion/Reader/Options">Options</a></li>
79
80 <li>&ldsh; <a href="./ion/Reader/Reader">Reader</a></li>
81
82 <li>&ldsh; <a href="./ion/Reader/countAnnotations">Reader::countAnnotations</a></li>
83
84 <li>&ldsh; <a href="./ion/Reader/getAnnotation">Reader::getAnnotation</a></li>
85
86 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbol">Reader::getAnnotationSymbol</a></li>
87
88 <li>&ldsh; <a href="./ion/Reader/getAnnotationSymbols">Reader::getAnnotationSymbols</a></li>
89
90 <li>&ldsh; <a href="./ion/Reader/getAnnotations">Reader::getAnnotations</a></li>
91
92 <li>&ldsh; <a href="./ion/Reader/getDepth">Reader::getDepth</a></li>
93
94 <li>&ldsh; <a href="./ion/Reader/getFieldName">Reader::getFieldName</a></li>
95
96 <li>&ldsh; <a href="./ion/Reader/getFieldNameSymbol">Reader::getFieldNameSymbol</a></li>
97
98 <li>&ldsh; <a href="./ion/Reader/getPosition">Reader::getPosition</a></li>
99
100 <li>&ldsh; <a href="./ion/Reader/getType">Reader::getType</a></li>
101
102 <li>&ldsh; <a href="./ion/Reader/getValueLength">Reader::getValueLength</a></li>
103
104 <li>&ldsh; <a href="./ion/Reader/getValueOffset">Reader::getValueOffset</a></li>
105
106 <li>&ldsh; <a href="./ion/Reader/hasAnnotation">Reader::hasAnnotation</a></li>
107
108 <li>&ldsh; <a href="./ion/Reader/hasAnnotations">Reader::hasAnnotations</a></li>
109
110 <li>&ldsh; <a href="./ion/Reader/isInStruct">Reader::isInStruct</a></li>
111
112 <li>&ldsh; <a href="./ion/Reader/isNull">Reader::isNull</a></li>
113
114 <li>&ldsh; <a href="./ion/Reader/readBool">Reader::readBool</a></li>
115
116 <li>&ldsh; <a href="./ion/Reader/readDecimal">Reader::readDecimal</a></li>
117
118 <li>&ldsh; <a href="./ion/Reader/readFloat">Reader::readFloat</a></li>
119
120 <li>&ldsh; <a href="./ion/Reader/readInt">Reader::readInt</a></li>
121
122 <li>&ldsh; <a href="./ion/Reader/readLob">Reader::readLob</a></li>
123
124 <li>&ldsh; <a href="./ion/Reader/readLobPart">Reader::readLobPart</a></li>
125
126 <li>&ldsh; <a href="./ion/Reader/readNull">Reader::readNull</a></li>
127
128 <li>&ldsh; <a href="./ion/Reader/readString">Reader::readString</a></li>
129
130 <li>&ldsh; <a href="./ion/Reader/readStringPart">Reader::readStringPart</a></li>
131
132 <li>&ldsh; <a href="./ion/Reader/readSymbol">Reader::readSymbol</a></li>
133
134 <li>&ldsh; <a href="./ion/Reader/readTimestamp">Reader::readTimestamp</a></li>
135
136 <li>&ldsh; <a href="./ion/Reader/seek">Reader::seek</a></li>
137
138 </ul>
139
140 </li>
141 </ul>
142
143 </li>
144 </ul>
145 </div>
146
147 <h1>interface ion\Reader\Stream implements Iterator, RecursiveIterator, Traversable, ion\Reader</h1>
148 <p>ION stream reader API.</p>
149 <h2>Constants:<a id="Constants:" href="#Constants:" class="permalink" aria-hidden="true" title="">#</a></h2>
150 <p>None.</p>
151 <h2>Properties:<a id="Properties:" href="#Properties:" class="permalink" aria-hidden="true" title="">#</a></h2>
152 <p>None.</p>
153
154
155
156 <h2 id="Functions:">Functions:</h2>
157 <ul>
158
159 <li>
160 <h3><a href="ion/Reader/Stream/getStream">Stream::getStream</a></h3>
161 <p>Get the stream read from.</p>
162
163 <p>void ion\Reader\Stream::getStream()</p>
164 </li>
165
166 <li>
167 <h3><a href="ion/Reader/Stream/resetStream">Stream::resetStream</a></h3>
168 <p>Reset the stream read from.</p>
169
170 <p>void ion\Reader\Stream::resetStream(resource $stream)</p>
171 </li>
172
173 <li>
174 <h3><a href="ion/Reader/Stream/resetStreamWithLength">Stream::resetStreamWithLength</a></h3>
175 <p>Reset the stream read from, limiting length to read.</p>
176
177 <p>void ion\Reader\Stream::resetStreamWithLength(resource $stream, int $length)</p>
178 </li>
179
180 </ul>
181
182
183 <h2 id="Namespaces,.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:</h2>
184 <ul>
185
186 <li>
187 <h3><a href="ion/Reader/Stream/Reader">Reader</a></h3>
188 <p>ION stream reader.</p>
189
190 <p>class ion\Reader\Stream\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Stream</p>
191 </li>
192
193 </ul>
194
195 <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
196 <script>
197 var disqus_shortname = 'mdref';
198 var disqus_identifier = 'ion/Reader/Stream';
199 </script>
200
201 <footer>
202
203 <ul>
204 <li><a href="https://github.com/m6w6/mdref">mdref-v2.0
205 </a></li>
206 <li><a href="LICENSE">&copy; 2013-2022 All rights reserved.</a></li>
207 <li>
208 </li>
209 </ul>
210
211 </footer>
212
213 <script src="index.js"></script>
214
215 </div>
216 </body>
217 </html>