/usr/share/doc/libjuce/apiref/classFileInputStream.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: FileInputStream Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classFileInputStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FileInputStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An input stream that reads from a local file.
<a href="classFileInputStream.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for FileInputStream:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classFileInputStream.png" usemap="#FileInputStream_map" alt=""/>
<map id="FileInputStream_map" name="FileInputStream_map">
<area href="classInputStream.html" title="The base class for streams that read data. " alt="InputStream" shape="rect" coords="0,0,99,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a277a7370f2a2f038e9258de395122510"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#a277a7370f2a2f038e9258de395122510">FileInputStream</a> (const <a class="el" href="classFile.html">File</a> &fileToRead)</td></tr>
<tr class="memdesc:a277a7370f2a2f038e9258de395122510"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classFileInputStream.html" title="An input stream that reads from a local file. ">FileInputStream</a> to read from the given file. <a href="#a277a7370f2a2f038e9258de395122510">More...</a><br /></td></tr>
<tr class="separator:a277a7370f2a2f038e9258de395122510"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48dfa318f2d5ebefc1489ac44edefde5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#a48dfa318f2d5ebefc1489ac44edefde5">~FileInputStream</a> ()</td></tr>
<tr class="memdesc:a48dfa318f2d5ebefc1489ac44edefde5"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a48dfa318f2d5ebefc1489ac44edefde5">More...</a><br /></td></tr>
<tr class="separator:a48dfa318f2d5ebefc1489ac44edefde5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f162d294de9de866f6ef74313faef68"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classFile.html">File</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#a4f162d294de9de866f6ef74313faef68">getFile</a> () const noexcept</td></tr>
<tr class="memdesc:a4f162d294de9de866f6ef74313faef68"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file that this stream is reading from. <a href="#a4f162d294de9de866f6ef74313faef68">More...</a><br /></td></tr>
<tr class="separator:a4f162d294de9de866f6ef74313faef68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace9aedfff3f4e9f375f6b5cd1bb056dd"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classResult.html">Result</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#ace9aedfff3f4e9f375f6b5cd1bb056dd">getStatus</a> () const noexcept</td></tr>
<tr class="memdesc:ace9aedfff3f4e9f375f6b5cd1bb056dd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the status of the file stream. <a href="#ace9aedfff3f4e9f375f6b5cd1bb056dd">More...</a><br /></td></tr>
<tr class="separator:ace9aedfff3f4e9f375f6b5cd1bb056dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a203bfaf432beeac638b8d6ec5bbce2c3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#a203bfaf432beeac638b8d6ec5bbce2c3">failedToOpen</a> () const noexcept</td></tr>
<tr class="memdesc:a203bfaf432beeac638b8d6ec5bbce2c3"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the stream couldn't be opened for some reason. <a href="#a203bfaf432beeac638b8d6ec5bbce2c3">More...</a><br /></td></tr>
<tr class="separator:a203bfaf432beeac638b8d6ec5bbce2c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45dc57c8101f565e505fed847723eb5d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#a45dc57c8101f565e505fed847723eb5d">openedOk</a> () const noexcept</td></tr>
<tr class="memdesc:a45dc57c8101f565e505fed847723eb5d"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the stream opened without problems. <a href="#a45dc57c8101f565e505fed847723eb5d">More...</a><br /></td></tr>
<tr class="separator:a45dc57c8101f565e505fed847723eb5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa9728f1553ac87d4185cda8c71868d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#aaa9728f1553ac87d4185cda8c71868d5">getTotalLength</a> () override</td></tr>
<tr class="memdesc:aaa9728f1553ac87d4185cda8c71868d5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total number of bytes available for reading in this stream. <a href="#aaa9728f1553ac87d4185cda8c71868d5">More...</a><br /></td></tr>
<tr class="separator:aaa9728f1553ac87d4185cda8c71868d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b78ed4e0bd123ef3996154ec6d89252"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#a1b78ed4e0bd123ef3996154ec6d89252">read</a> (void *, int) override</td></tr>
<tr class="memdesc:a1b78ed4e0bd123ef3996154ec6d89252"><td class="mdescLeft"> </td><td class="mdescRight">Reads some data from the stream into a memory buffer. <a href="#a1b78ed4e0bd123ef3996154ec6d89252">More...</a><br /></td></tr>
<tr class="separator:a1b78ed4e0bd123ef3996154ec6d89252"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac325ed1556edf2ea959b1c05f6f1fb2a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#ac325ed1556edf2ea959b1c05f6f1fb2a">isExhausted</a> () override</td></tr>
<tr class="memdesc:ac325ed1556edf2ea959b1c05f6f1fb2a"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the stream has no more data to read. <a href="#ac325ed1556edf2ea959b1c05f6f1fb2a">More...</a><br /></td></tr>
<tr class="separator:ac325ed1556edf2ea959b1c05f6f1fb2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6dddfc6ee214e6e7ac32b891c5d7209"><td class="memItemLeft" align="right" valign="top"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#af6dddfc6ee214e6e7ac32b891c5d7209">getPosition</a> () override</td></tr>
<tr class="memdesc:af6dddfc6ee214e6e7ac32b891c5d7209"><td class="mdescLeft"> </td><td class="mdescRight">Returns the offset of the next byte that will be read from the stream. <a href="#af6dddfc6ee214e6e7ac32b891c5d7209">More...</a><br /></td></tr>
<tr class="separator:af6dddfc6ee214e6e7ac32b891c5d7209"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a204dabd8c94c480fecdd55276f7125e7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileInputStream.html#a204dabd8c94c480fecdd55276f7125e7">setPosition</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a>) override</td></tr>
<tr class="memdesc:a204dabd8c94c480fecdd55276f7125e7"><td class="mdescLeft"> </td><td class="mdescRight">Tries to move the current read position of the stream. <a href="#a204dabd8c94c480fecdd55276f7125e7">More...</a><br /></td></tr>
<tr class="separator:a204dabd8c94c480fecdd55276f7125e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classInputStream"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classInputStream')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classInputStream.html">InputStream</a></td></tr>
<tr class="memitem:a8c49246dd62e559578732f518f159432 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a8c49246dd62e559578732f518f159432">~InputStream</a> ()</td></tr>
<tr class="memdesc:a8c49246dd62e559578732f518f159432 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classInputStream.html#a8c49246dd62e559578732f518f159432">More...</a><br /></td></tr>
<tr class="separator:a8c49246dd62e559578732f518f159432 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc989306067e47deabad840d05846290 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#adc989306067e47deabad840d05846290">getNumBytesRemaining</a> ()</td></tr>
<tr class="memdesc:adc989306067e47deabad840d05846290 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bytes available for reading, or a negative value if the remaining length is not known. <a href="classInputStream.html#adc989306067e47deabad840d05846290">More...</a><br /></td></tr>
<tr class="separator:adc989306067e47deabad840d05846290 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e5944641712d84b6da2eee5d394326a inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual char </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a2e5944641712d84b6da2eee5d394326a">readByte</a> ()</td></tr>
<tr class="memdesc:a2e5944641712d84b6da2eee5d394326a inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads a byte from the stream. <a href="classInputStream.html#a2e5944641712d84b6da2eee5d394326a">More...</a><br /></td></tr>
<tr class="separator:a2e5944641712d84b6da2eee5d394326a inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37d1e4956da4fb9f765f16f9c4b4ec3b inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a37d1e4956da4fb9f765f16f9c4b4ec3b">readBool</a> ()</td></tr>
<tr class="memdesc:a37d1e4956da4fb9f765f16f9c4b4ec3b inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads a boolean from the stream. <a href="classInputStream.html#a37d1e4956da4fb9f765f16f9c4b4ec3b">More...</a><br /></td></tr>
<tr class="separator:a37d1e4956da4fb9f765f16f9c4b4ec3b inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c4b0f9f1fa9515fea5a98d2ffe7ae02 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual short </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a0c4b0f9f1fa9515fea5a98d2ffe7ae02">readShort</a> ()</td></tr>
<tr class="memdesc:a0c4b0f9f1fa9515fea5a98d2ffe7ae02 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads two bytes from the stream as a little-endian 16-bit value. <a href="classInputStream.html#a0c4b0f9f1fa9515fea5a98d2ffe7ae02">More...</a><br /></td></tr>
<tr class="separator:a0c4b0f9f1fa9515fea5a98d2ffe7ae02 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac33bbf8ae4597a30bde70cbdbc6bfa5b inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual short </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#ac33bbf8ae4597a30bde70cbdbc6bfa5b">readShortBigEndian</a> ()</td></tr>
<tr class="memdesc:ac33bbf8ae4597a30bde70cbdbc6bfa5b inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads two bytes from the stream as a little-endian 16-bit value. <a href="classInputStream.html#ac33bbf8ae4597a30bde70cbdbc6bfa5b">More...</a><br /></td></tr>
<tr class="separator:ac33bbf8ae4597a30bde70cbdbc6bfa5b inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59eb456ebfbe9d4c7fdfd4c14337e19a inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a59eb456ebfbe9d4c7fdfd4c14337e19a">readInt</a> ()</td></tr>
<tr class="memdesc:a59eb456ebfbe9d4c7fdfd4c14337e19a inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads four bytes from the stream as a little-endian 32-bit value. <a href="classInputStream.html#a59eb456ebfbe9d4c7fdfd4c14337e19a">More...</a><br /></td></tr>
<tr class="separator:a59eb456ebfbe9d4c7fdfd4c14337e19a inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84ab1bcc547eee621c4c6c2502af808d inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a84ab1bcc547eee621c4c6c2502af808d">readIntBigEndian</a> ()</td></tr>
<tr class="memdesc:a84ab1bcc547eee621c4c6c2502af808d inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads four bytes from the stream as a big-endian 32-bit value. <a href="classInputStream.html#a84ab1bcc547eee621c4c6c2502af808d">More...</a><br /></td></tr>
<tr class="separator:a84ab1bcc547eee621c4c6c2502af808d inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58941fd7cf4279e49d4697750f837a56 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a58941fd7cf4279e49d4697750f837a56">readInt64</a> ()</td></tr>
<tr class="memdesc:a58941fd7cf4279e49d4697750f837a56 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads eight bytes from the stream as a little-endian 64-bit value. <a href="classInputStream.html#a58941fd7cf4279e49d4697750f837a56">More...</a><br /></td></tr>
<tr class="separator:a58941fd7cf4279e49d4697750f837a56 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8894f1c01c6e0de4b5dd9b9c1fe06c4b inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a8894f1c01c6e0de4b5dd9b9c1fe06c4b">readInt64BigEndian</a> ()</td></tr>
<tr class="memdesc:a8894f1c01c6e0de4b5dd9b9c1fe06c4b inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads eight bytes from the stream as a big-endian 64-bit value. <a href="classInputStream.html#a8894f1c01c6e0de4b5dd9b9c1fe06c4b">More...</a><br /></td></tr>
<tr class="separator:a8894f1c01c6e0de4b5dd9b9c1fe06c4b inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46d7f191f1872bc27550db3fa0733f59 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a46d7f191f1872bc27550db3fa0733f59">readFloat</a> ()</td></tr>
<tr class="memdesc:a46d7f191f1872bc27550db3fa0733f59 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads four bytes as a 32-bit floating point value. <a href="classInputStream.html#a46d7f191f1872bc27550db3fa0733f59">More...</a><br /></td></tr>
<tr class="separator:a46d7f191f1872bc27550db3fa0733f59 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d19fef152296085c477882e0650b011 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a4d19fef152296085c477882e0650b011">readFloatBigEndian</a> ()</td></tr>
<tr class="memdesc:a4d19fef152296085c477882e0650b011 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads four bytes as a 32-bit floating point value. <a href="classInputStream.html#a4d19fef152296085c477882e0650b011">More...</a><br /></td></tr>
<tr class="separator:a4d19fef152296085c477882e0650b011 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31626a82ad48629a202135ac925ffecd inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a31626a82ad48629a202135ac925ffecd">readDouble</a> ()</td></tr>
<tr class="memdesc:a31626a82ad48629a202135ac925ffecd inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads eight bytes as a 64-bit floating point value. <a href="classInputStream.html#a31626a82ad48629a202135ac925ffecd">More...</a><br /></td></tr>
<tr class="separator:a31626a82ad48629a202135ac925ffecd inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c7a2928053424caf51986d9e6fdaa35 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a7c7a2928053424caf51986d9e6fdaa35">readDoubleBigEndian</a> ()</td></tr>
<tr class="memdesc:a7c7a2928053424caf51986d9e6fdaa35 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads eight bytes as a 64-bit floating point value. <a href="classInputStream.html#a7c7a2928053424caf51986d9e6fdaa35">More...</a><br /></td></tr>
<tr class="separator:a7c7a2928053424caf51986d9e6fdaa35 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e3643991f4103c5cfc1b8c61c6a3e92 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a3e3643991f4103c5cfc1b8c61c6a3e92">readCompressedInt</a> ()</td></tr>
<tr class="memdesc:a3e3643991f4103c5cfc1b8c61c6a3e92 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads an encoded 32-bit number from the stream using a space-saving compressed format. <a href="classInputStream.html#a3e3643991f4103c5cfc1b8c61c6a3e92">More...</a><br /></td></tr>
<tr class="separator:a3e3643991f4103c5cfc1b8c61c6a3e92 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af16acc8f2fd769adb559a781ece8e903 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#af16acc8f2fd769adb559a781ece8e903">readNextLine</a> ()</td></tr>
<tr class="memdesc:af16acc8f2fd769adb559a781ece8e903 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads a UTF-8 string from the stream, up to the next linefeed or carriage return. <a href="classInputStream.html#af16acc8f2fd769adb559a781ece8e903">More...</a><br /></td></tr>
<tr class="separator:af16acc8f2fd769adb559a781ece8e903 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abff18ad6e416d45f19d347abd3433665 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#abff18ad6e416d45f19d347abd3433665">readString</a> ()</td></tr>
<tr class="memdesc:abff18ad6e416d45f19d347abd3433665 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads a zero-terminated UTF-8 string from the stream. <a href="classInputStream.html#abff18ad6e416d45f19d347abd3433665">More...</a><br /></td></tr>
<tr class="separator:abff18ad6e416d45f19d347abd3433665 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb956ec5838d7f64153141ef51977c40 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#aeb956ec5838d7f64153141ef51977c40">readEntireStreamAsString</a> ()</td></tr>
<tr class="memdesc:aeb956ec5838d7f64153141ef51977c40 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Tries to read the whole stream and turn it into a string. <a href="classInputStream.html#aeb956ec5838d7f64153141ef51977c40">More...</a><br /></td></tr>
<tr class="separator:aeb956ec5838d7f64153141ef51977c40 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7708d25af96e8d8b937a4642dcf55a23 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a7708d25af96e8d8b937a4642dcf55a23">readIntoMemoryBlock</a> (<a class="el" href="classMemoryBlock.html">MemoryBlock</a> &destBlock, ssize_t maxNumBytesToRead=-1)</td></tr>
<tr class="memdesc:a7708d25af96e8d8b937a4642dcf55a23 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads from the stream and appends the data to a <a class="el" href="classMemoryBlock.html" title="A class to hold a resizable block of raw data. ">MemoryBlock</a>. <a href="classInputStream.html#a7708d25af96e8d8b937a4642dcf55a23">More...</a><br /></td></tr>
<tr class="separator:a7708d25af96e8d8b937a4642dcf55a23 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e3005cc6a58cd2ded6094dd6dd06542 inherit pub_methods_classInputStream"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a7e3005cc6a58cd2ded6094dd6dd06542">skipNextBytes</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> numBytesToSkip)</td></tr>
<tr class="memdesc:a7e3005cc6a58cd2ded6094dd6dd06542 inherit pub_methods_classInputStream"><td class="mdescLeft"> </td><td class="mdescRight">Reads and discards a number of bytes from the stream. <a href="classInputStream.html#a7e3005cc6a58cd2ded6094dd6dd06542">More...</a><br /></td></tr>
<tr class="separator:a7e3005cc6a58cd2ded6094dd6dd06542 inherit pub_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classInputStream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classInputStream')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classInputStream.html">InputStream</a></td></tr>
<tr class="memitem:a7652c5cf6f92901c99ddb19a8adf2268 inherit pro_methods_classInputStream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#a7652c5cf6f92901c99ddb19a8adf2268">InputStream</a> () noexcept</td></tr>
<tr class="separator:a7652c5cf6f92901c99ddb19a8adf2268 inherit pro_methods_classInputStream"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An input stream that reads from a local file. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html" title="The base class for streams that read data. ">InputStream</a>, <a class="el" href="classFileOutputStream.html" title="An output stream that writes into a local file. ">FileOutputStream</a>, <a class="el" href="classFile.html#ad5512424b64d50f10302788c294ab729" title="Creates a stream to read from this file. ">File::createInputStream</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a277a7370f2a2f038e9258de395122510"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a277a7370f2a2f038e9258de395122510">§ </a></span>FileInputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FileInputStream::FileInputStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>fileToRead</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classFileInputStream.html" title="An input stream that reads from a local file. ">FileInputStream</a> to read from the given file. </p>
<p>After creating a <a class="el" href="classFileInputStream.html" title="An input stream that reads from a local file. ">FileInputStream</a>, you should use <a class="el" href="classFileInputStream.html#a45dc57c8101f565e505fed847723eb5d" title="Returns true if the stream opened without problems. ">openedOk()</a> or <a class="el" href="classFileInputStream.html#a203bfaf432beeac638b8d6ec5bbce2c3" title="Returns true if the stream couldn't be opened for some reason. ">failedToOpen()</a> to make sure that it's OK before trying to read from it! If it failed, you can call <a class="el" href="classFileInputStream.html#ace9aedfff3f4e9f375f6b5cd1bb056dd" title="Returns the status of the file stream. ">getStatus()</a> to get more error information. </p>
</div>
</div>
<a id="a48dfa318f2d5ebefc1489ac44edefde5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48dfa318f2d5ebefc1489ac44edefde5">§ </a></span>~FileInputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileInputStream::~FileInputStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4f162d294de9de866f6ef74313faef68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f162d294de9de866f6ef74313faef68">§ </a></span>getFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classFile.html">File</a>& FileInputStream::getFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the file that this stream is reading from. </p>
</div>
</div>
<a id="ace9aedfff3f4e9f375f6b5cd1bb056dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace9aedfff3f4e9f375f6b5cd1bb056dd">§ </a></span>getStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classResult.html">Result</a>& FileInputStream::getStatus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the status of the file stream. </p>
<p>The result will be ok if the file opened successfully. If an error occurs while opening or reading from the file, this will contain an error message. </p>
</div>
</div>
<a id="a203bfaf432beeac638b8d6ec5bbce2c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a203bfaf432beeac638b8d6ec5bbce2c3">§ </a></span>failedToOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool FileInputStream::failedToOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the stream couldn't be opened for some reason. </p>
<dl class="section see"><dt>See also</dt><dd>getResult() </dd></dl>
</div>
</div>
<a id="a45dc57c8101f565e505fed847723eb5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45dc57c8101f565e505fed847723eb5d">§ </a></span>openedOk()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool FileInputStream::openedOk </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the stream opened without problems. </p>
<dl class="section see"><dt>See also</dt><dd>getResult() </dd></dl>
<p>References <a class="el" href="classInputStream.html#abf909e2de145df97221ab4deb2824c5c">InputStream::getPosition()</a>, <a class="el" href="classInputStream.html#aebacb933570264e9697f6c984e348d01">InputStream::getTotalLength()</a>, <a class="el" href="classInputStream.html#aabacc50cde9fcabe4752c796648fde49">InputStream::isExhausted()</a>, <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>, <a class="el" href="classInputStream.html#aa5350c414bad6b97ae3b463a3401c0d6">InputStream::read()</a>, and <a class="el" href="classInputStream.html#ad7b4e8cec1e383657900e27bbcb3b06c">InputStream::setPosition()</a>.</p>
</div>
</div>
<a id="aaa9728f1553ac87d4185cda8c71868d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa9728f1553ac87d4185cda8c71868d5">§ </a></span>getTotalLength()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> FileInputStream::getTotalLength </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the total number of bytes available for reading in this stream. </p>
<p>Note that this is the number of bytes available from the start of the stream, not from the current position.</p>
<p>If the size of the stream isn't actually known, this will return -1.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#adc989306067e47deabad840d05846290" title="Returns the number of bytes available for reading, or a negative value if the remaining length is not...">getNumBytesRemaining</a> </dd></dl>
<p>Implements <a class="el" href="classInputStream.html#aebacb933570264e9697f6c984e348d01">InputStream</a>.</p>
</div>
</div>
<a id="a1b78ed4e0bd123ef3996154ec6d89252"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b78ed4e0bd123ef3996154ec6d89252">§ </a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int FileInputStream::read </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>destBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxBytesToRead</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads some data from the stream into a memory buffer. </p>
<p>This is the only read method that subclasses actually need to implement, as the <a class="el" href="classInputStream.html" title="The base class for streams that read data. ">InputStream</a> base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">destBuffer</td><td>the destination buffer for the data. This must not be null. </td></tr>
<tr><td class="paramname">maxBytesToRead</td><td>the maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. This value must not be negative.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the actual number of bytes that were read, which may be less than maxBytesToRead if the stream is exhausted before it gets that far </dd></dl>
<p>Implements <a class="el" href="classInputStream.html#aa5350c414bad6b97ae3b463a3401c0d6">InputStream</a>.</p>
</div>
</div>
<a id="ac325ed1556edf2ea959b1c05f6f1fb2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac325ed1556edf2ea959b1c05f6f1fb2a">§ </a></span>isExhausted()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool FileInputStream::isExhausted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the stream has no more data to read. </p>
<p>Implements <a class="el" href="classInputStream.html#aabacc50cde9fcabe4752c796648fde49">InputStream</a>.</p>
</div>
</div>
<a id="af6dddfc6ee214e6e7ac32b891c5d7209"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6dddfc6ee214e6e7ac32b891c5d7209">§ </a></span>getPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> FileInputStream::getPosition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the offset of the next byte that will be read from the stream. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileInputStream.html#a204dabd8c94c480fecdd55276f7125e7" title="Tries to move the current read position of the stream. ">setPosition</a> </dd></dl>
<p>Implements <a class="el" href="classInputStream.html#abf909e2de145df97221ab4deb2824c5c">InputStream</a>.</p>
</div>
</div>
<a id="a204dabd8c94c480fecdd55276f7125e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a204dabd8c94c480fecdd55276f7125e7">§ </a></span>setPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool FileInputStream::setPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>newPosition</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to move the current read position of the stream. </p>
<p>The position is an absolute number of bytes from the stream's start.</p>
<p>Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.</p>
<dl class="section return"><dt>Returns</dt><dd>true if the stream manages to reposition itself correctly </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileInputStream.html#af6dddfc6ee214e6e7ac32b891c5d7209" title="Returns the offset of the next byte that will be read from the stream. ">getPosition</a> </dd></dl>
<p>Implements <a class="el" href="classInputStream.html#ad7b4e8cec1e383657900e27bbcb3b06c">InputStream</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__FileInputStream_8h.html">juce_FileInputStream.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|