/usr/share/doc/libjuce/apiref/classInputStream.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 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 | <!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: InputStream 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="#pro-methods">Protected Member Functions</a> |
<a href="classInputStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">InputStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The base class for streams that read data.
<a href="classInputStream.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 InputStream:</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="classInputStream.png" usemap="#InputStream_map" alt=""/>
<map id="InputStream_map" name="InputStream_map">
<area href="classBufferedInputStream.html" title="Wraps another input stream, and reads from it using an intermediate buffer. " alt="BufferedInputStream" shape="rect" coords="0,56,189,80"/>
<area href="classFileInputStream.html" title="An input stream that reads from a local file. " alt="FileInputStream" shape="rect" coords="199,56,388,80"/>
<area href="classGZIPDecompressorInputStream.html" title="This stream will decompress a source-stream using zlib. " alt="GZIPDecompressorInputStream" shape="rect" coords="398,56,587,80"/>
<area href="classMemoryInputStream.html" title="Allows a block of data to be accessed as a stream. " alt="MemoryInputStream" shape="rect" coords="597,56,786,80"/>
<area href="classSubregionStream.html" title="Wraps another input stream, and reads from a specific part of it. " alt="SubregionStream" shape="rect" coords="796,56,985,80"/>
</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:a8c49246dd62e559578732f518f159432"><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"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a8c49246dd62e559578732f518f159432">More...</a><br /></td></tr>
<tr class="separator:a8c49246dd62e559578732f518f159432"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebacb933570264e9697f6c984e348d01"><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#aebacb933570264e9697f6c984e348d01">getTotalLength</a> ()=0</td></tr>
<tr class="memdesc:aebacb933570264e9697f6c984e348d01"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total number of bytes available for reading in this stream. <a href="#aebacb933570264e9697f6c984e348d01">More...</a><br /></td></tr>
<tr class="separator:aebacb933570264e9697f6c984e348d01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc989306067e47deabad840d05846290"><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"><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="#adc989306067e47deabad840d05846290">More...</a><br /></td></tr>
<tr class="separator:adc989306067e47deabad840d05846290"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabacc50cde9fcabe4752c796648fde49"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#aabacc50cde9fcabe4752c796648fde49">isExhausted</a> ()=0</td></tr>
<tr class="memdesc:aabacc50cde9fcabe4752c796648fde49"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the stream has no more data to read. <a href="#aabacc50cde9fcabe4752c796648fde49">More...</a><br /></td></tr>
<tr class="separator:aabacc50cde9fcabe4752c796648fde49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5350c414bad6b97ae3b463a3401c0d6"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#aa5350c414bad6b97ae3b463a3401c0d6">read</a> (void *destBuffer, int maxBytesToRead)=0</td></tr>
<tr class="memdesc:aa5350c414bad6b97ae3b463a3401c0d6"><td class="mdescLeft"> </td><td class="mdescRight">Reads some data from the stream into a memory buffer. <a href="#aa5350c414bad6b97ae3b463a3401c0d6">More...</a><br /></td></tr>
<tr class="separator:aa5350c414bad6b97ae3b463a3401c0d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e5944641712d84b6da2eee5d394326a"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads a byte from the stream. <a href="#a2e5944641712d84b6da2eee5d394326a">More...</a><br /></td></tr>
<tr class="separator:a2e5944641712d84b6da2eee5d394326a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37d1e4956da4fb9f765f16f9c4b4ec3b"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads a boolean from the stream. <a href="#a37d1e4956da4fb9f765f16f9c4b4ec3b">More...</a><br /></td></tr>
<tr class="separator:a37d1e4956da4fb9f765f16f9c4b4ec3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c4b0f9f1fa9515fea5a98d2ffe7ae02"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads two bytes from the stream as a little-endian 16-bit value. <a href="#a0c4b0f9f1fa9515fea5a98d2ffe7ae02">More...</a><br /></td></tr>
<tr class="separator:a0c4b0f9f1fa9515fea5a98d2ffe7ae02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac33bbf8ae4597a30bde70cbdbc6bfa5b"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads two bytes from the stream as a little-endian 16-bit value. <a href="#ac33bbf8ae4597a30bde70cbdbc6bfa5b">More...</a><br /></td></tr>
<tr class="separator:ac33bbf8ae4597a30bde70cbdbc6bfa5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59eb456ebfbe9d4c7fdfd4c14337e19a"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads four bytes from the stream as a little-endian 32-bit value. <a href="#a59eb456ebfbe9d4c7fdfd4c14337e19a">More...</a><br /></td></tr>
<tr class="separator:a59eb456ebfbe9d4c7fdfd4c14337e19a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84ab1bcc547eee621c4c6c2502af808d"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads four bytes from the stream as a big-endian 32-bit value. <a href="#a84ab1bcc547eee621c4c6c2502af808d">More...</a><br /></td></tr>
<tr class="separator:a84ab1bcc547eee621c4c6c2502af808d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58941fd7cf4279e49d4697750f837a56"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads eight bytes from the stream as a little-endian 64-bit value. <a href="#a58941fd7cf4279e49d4697750f837a56">More...</a><br /></td></tr>
<tr class="separator:a58941fd7cf4279e49d4697750f837a56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8894f1c01c6e0de4b5dd9b9c1fe06c4b"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads eight bytes from the stream as a big-endian 64-bit value. <a href="#a8894f1c01c6e0de4b5dd9b9c1fe06c4b">More...</a><br /></td></tr>
<tr class="separator:a8894f1c01c6e0de4b5dd9b9c1fe06c4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46d7f191f1872bc27550db3fa0733f59"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads four bytes as a 32-bit floating point value. <a href="#a46d7f191f1872bc27550db3fa0733f59">More...</a><br /></td></tr>
<tr class="separator:a46d7f191f1872bc27550db3fa0733f59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d19fef152296085c477882e0650b011"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads four bytes as a 32-bit floating point value. <a href="#a4d19fef152296085c477882e0650b011">More...</a><br /></td></tr>
<tr class="separator:a4d19fef152296085c477882e0650b011"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31626a82ad48629a202135ac925ffecd"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads eight bytes as a 64-bit floating point value. <a href="#a31626a82ad48629a202135ac925ffecd">More...</a><br /></td></tr>
<tr class="separator:a31626a82ad48629a202135ac925ffecd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c7a2928053424caf51986d9e6fdaa35"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads eight bytes as a 64-bit floating point value. <a href="#a7c7a2928053424caf51986d9e6fdaa35">More...</a><br /></td></tr>
<tr class="separator:a7c7a2928053424caf51986d9e6fdaa35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e3643991f4103c5cfc1b8c61c6a3e92"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads an encoded 32-bit number from the stream using a space-saving compressed format. <a href="#a3e3643991f4103c5cfc1b8c61c6a3e92">More...</a><br /></td></tr>
<tr class="separator:a3e3643991f4103c5cfc1b8c61c6a3e92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af16acc8f2fd769adb559a781ece8e903"><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"><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="#af16acc8f2fd769adb559a781ece8e903">More...</a><br /></td></tr>
<tr class="separator:af16acc8f2fd769adb559a781ece8e903"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abff18ad6e416d45f19d347abd3433665"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads a zero-terminated UTF-8 string from the stream. <a href="#abff18ad6e416d45f19d347abd3433665">More...</a><br /></td></tr>
<tr class="separator:abff18ad6e416d45f19d347abd3433665"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb956ec5838d7f64153141ef51977c40"><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"><td class="mdescLeft"> </td><td class="mdescRight">Tries to read the whole stream and turn it into a string. <a href="#aeb956ec5838d7f64153141ef51977c40">More...</a><br /></td></tr>
<tr class="separator:aeb956ec5838d7f64153141ef51977c40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7708d25af96e8d8b937a4642dcf55a23"><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"><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="#a7708d25af96e8d8b937a4642dcf55a23">More...</a><br /></td></tr>
<tr class="separator:a7708d25af96e8d8b937a4642dcf55a23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf909e2de145df97221ab4deb2824c5c"><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#abf909e2de145df97221ab4deb2824c5c">getPosition</a> ()=0</td></tr>
<tr class="memdesc:abf909e2de145df97221ab4deb2824c5c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the offset of the next byte that will be read from the stream. <a href="#abf909e2de145df97221ab4deb2824c5c">More...</a><br /></td></tr>
<tr class="separator:abf909e2de145df97221ab4deb2824c5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7b4e8cec1e383657900e27bbcb3b06c"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInputStream.html#ad7b4e8cec1e383657900e27bbcb3b06c">setPosition</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> newPosition)=0</td></tr>
<tr class="memdesc:ad7b4e8cec1e383657900e27bbcb3b06c"><td class="mdescLeft"> </td><td class="mdescRight">Tries to move the current read position of the stream. <a href="#ad7b4e8cec1e383657900e27bbcb3b06c">More...</a><br /></td></tr>
<tr class="separator:ad7b4e8cec1e383657900e27bbcb3b06c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e3005cc6a58cd2ded6094dd6dd06542"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reads and discards a number of bytes from the stream. <a href="#a7e3005cc6a58cd2ded6094dd6dd06542">More...</a><br /></td></tr>
<tr class="separator:a7e3005cc6a58cd2ded6094dd6dd06542"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a7652c5cf6f92901c99ddb19a8adf2268"><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"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The base class for streams that read data. </p>
<p>Input and output streams are used throughout the library - subclasses can override some or all of the virtual functions to implement their behaviour.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html" title="The base class for streams that write data to some kind of destination. ">OutputStream</a>, <a class="el" href="classMemoryInputStream.html" title="Allows a block of data to be accessed as a stream. ">MemoryInputStream</a>, <a class="el" href="classBufferedInputStream.html" title="Wraps another input stream, and reads from it using an intermediate buffer. ">BufferedInputStream</a>, <a class="el" href="classFileInputStream.html" title="An input stream that reads from a local file. ">FileInputStream</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a8c49246dd62e559578732f518f159432"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c49246dd62e559578732f518f159432">§ </a></span>~InputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual InputStream::~InputStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<a id="a7652c5cf6f92901c99ddb19a8adf2268"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7652c5cf6f92901c99ddb19a8adf2268">§ </a></span>InputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">InputStream::InputStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aebacb933570264e9697f6c984e348d01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebacb933570264e9697f6c984e348d01">§ </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">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> InputStream::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">pure 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>Implemented in <a class="el" href="classGZIPDecompressorInputStream.html#a42cdcb3cd546cb0cbbffe52f8763a5c0">GZIPDecompressorInputStream</a>, <a class="el" href="classMemoryInputStream.html#ac1c6d007a1bb1812083558bb5d7878c4">MemoryInputStream</a>, <a class="el" href="classFileInputStream.html#aaa9728f1553ac87d4185cda8c71868d5">FileInputStream</a>, <a class="el" href="classSubregionStream.html#a441905b743b491d74e5df6ee93ac2cbc">SubregionStream</a>, and <a class="el" href="classBufferedInputStream.html#a6d304c21b8b657fc6429815ea5d26553">BufferedInputStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryInputStream.html#aca7db79c18dbd0d425249aef22b22ba3">MemoryInputStream::getDataSize()</a>, and <a class="el" href="classFileInputStream.html#a45dc57c8101f565e505fed847723eb5d">FileInputStream::openedOk()</a>.</p>
</div>
</div>
<a id="adc989306067e47deabad840d05846290"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc989306067e47deabad840d05846290">§ </a></span>getNumBytesRemaining()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> InputStream::getNumBytesRemaining </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of bytes available for reading, or a negative value if the remaining length is not known. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputStream.html#aebacb933570264e9697f6c984e348d01" title="Returns the total number of bytes available for reading in this stream. ">getTotalLength</a> </dd></dl>
</div>
</div>
<a id="aabacc50cde9fcabe4752c796648fde49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabacc50cde9fcabe4752c796648fde49">§ </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">virtual bool InputStream::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the stream has no more data to read. </p>
<p>Implemented in <a class="el" href="classGZIPDecompressorInputStream.html#a9ee15e46115074b0bccb9029480b5c22">GZIPDecompressorInputStream</a>, <a class="el" href="classMemoryInputStream.html#a7a8388329149a66a00e73734fbb303d5">MemoryInputStream</a>, <a class="el" href="classFileInputStream.html#ac325ed1556edf2ea959b1c05f6f1fb2a">FileInputStream</a>, <a class="el" href="classBufferedInputStream.html#a22ebb22c9c3ee96ebabf6b025b957771">BufferedInputStream</a>, and <a class="el" href="classSubregionStream.html#afc7bc8ebf245d894aa7974ba15f77b36">SubregionStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryInputStream.html#aca7db79c18dbd0d425249aef22b22ba3">MemoryInputStream::getDataSize()</a>, and <a class="el" href="classFileInputStream.html#a45dc57c8101f565e505fed847723eb5d">FileInputStream::openedOk()</a>.</p>
</div>
</div>
<a id="aa5350c414bad6b97ae3b463a3401c0d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5350c414bad6b97ae3b463a3401c0d6">§ </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">virtual int InputStream::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">pure 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>Implemented in <a class="el" href="classGZIPDecompressorInputStream.html#a1b8deaae7ddf6028c7ddf5619c5489e6">GZIPDecompressorInputStream</a>, <a class="el" href="classMemoryInputStream.html#a86d8876c0c32633f42e232435e21ebaa">MemoryInputStream</a>, <a class="el" href="classFileInputStream.html#a1b78ed4e0bd123ef3996154ec6d89252">FileInputStream</a>, <a class="el" href="classSubregionStream.html#ab1ccc36bcfae767109fa12fb03b4de31">SubregionStream</a>, and <a class="el" href="classBufferedInputStream.html#a5f210b5232af59aff2d01279174d9d9c">BufferedInputStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryInputStream.html#aca7db79c18dbd0d425249aef22b22ba3">MemoryInputStream::getDataSize()</a>, and <a class="el" href="classFileInputStream.html#a45dc57c8101f565e505fed847723eb5d">FileInputStream::openedOk()</a>.</p>
</div>
</div>
<a id="a2e5944641712d84b6da2eee5d394326a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e5944641712d84b6da2eee5d394326a">§ </a></span>readByte()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual char InputStream::readByte </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a byte from the stream. </p>
<p>If the stream is exhausted, this will return zero. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#aaa3aee845d1cd8db87533313c12c0963" title="Writes a single byte to the stream. ">OutputStream::writeByte</a> </dd></dl>
</div>
</div>
<a id="a37d1e4956da4fb9f765f16f9c4b4ec3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37d1e4956da4fb9f765f16f9c4b4ec3b">§ </a></span>readBool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool InputStream::readBool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a boolean from the stream. </p>
<p>The bool is encoded as a single byte - non-zero for true, 0 for false. If the stream is exhausted, this will return false. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#aac4bd355924dfb91aa71aa5c6c251924" title="Writes a boolean to the stream as a single byte. ">OutputStream::writeBool</a> </dd></dl>
</div>
</div>
<a id="a0c4b0f9f1fa9515fea5a98d2ffe7ae02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c4b0f9f1fa9515fea5a98d2ffe7ae02">§ </a></span>readShort()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual short InputStream::readShort </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads two bytes from the stream as a little-endian 16-bit value. </p>
<p>If the next two bytes read are byte1 and byte2, this returns (byte1 | (byte2 << 8)). If the stream is exhausted partway through reading the bytes, this will return zero. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#aa0c31878ffe72db678ad2df92f977b79" title="Writes a 16-bit integer to the stream in a little-endian byte order. ">OutputStream::writeShort</a>, <a class="el" href="classInputStream.html#ac33bbf8ae4597a30bde70cbdbc6bfa5b" title="Reads two bytes from the stream as a little-endian 16-bit value. ">readShortBigEndian</a> </dd></dl>
</div>
</div>
<a id="ac33bbf8ae4597a30bde70cbdbc6bfa5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac33bbf8ae4597a30bde70cbdbc6bfa5b">§ </a></span>readShortBigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual short InputStream::readShortBigEndian </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads two bytes from the stream as a little-endian 16-bit value. </p>
<p>If the next two bytes read are byte1 and byte2, this returns (byte2 | (byte1 << 8)). If the stream is exhausted partway through reading the bytes, this will return zero. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#a2f5dec34d9771edea9c0535eb5b58860" title="Writes a 16-bit integer to the stream in a big-endian byte order. ">OutputStream::writeShortBigEndian</a>, <a class="el" href="classInputStream.html#a0c4b0f9f1fa9515fea5a98d2ffe7ae02" title="Reads two bytes from the stream as a little-endian 16-bit value. ">readShort</a> </dd></dl>
</div>
</div>
<a id="a59eb456ebfbe9d4c7fdfd4c14337e19a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59eb456ebfbe9d4c7fdfd4c14337e19a">§ </a></span>readInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int InputStream::readInt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads four bytes from the stream as a little-endian 32-bit value. </p>
<p>If the next four bytes are byte1 to byte4, this returns (byte1 | (byte2 << 8) | (byte3 << 16) | (byte4 << 24)).</p>
<p>If the stream is exhausted partway through reading the bytes, this will return zero.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#a75f455e1a6e4da9190cd77bc01657622" title="Writes a 32-bit integer to the stream in a little-endian byte order. ">OutputStream::writeInt</a>, <a class="el" href="classInputStream.html#a84ab1bcc547eee621c4c6c2502af808d" title="Reads four bytes from the stream as a big-endian 32-bit value. ">readIntBigEndian</a> </dd></dl>
</div>
</div>
<a id="a84ab1bcc547eee621c4c6c2502af808d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84ab1bcc547eee621c4c6c2502af808d">§ </a></span>readIntBigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int InputStream::readIntBigEndian </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads four bytes from the stream as a big-endian 32-bit value. </p>
<p>If the next four bytes are byte1 to byte4, this returns (byte4 | (byte3 << 8) | (byte2 << 16) | (byte1 << 24)).</p>
<p>If the stream is exhausted partway through reading the bytes, this will return zero.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#ac42573016fc3f343dc9692d55d455f1b" title="Writes a 32-bit integer to the stream in a big-endian byte order. ">OutputStream::writeIntBigEndian</a>, <a class="el" href="classInputStream.html#a59eb456ebfbe9d4c7fdfd4c14337e19a" title="Reads four bytes from the stream as a little-endian 32-bit value. ">readInt</a> </dd></dl>
</div>
</div>
<a id="a58941fd7cf4279e49d4697750f837a56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58941fd7cf4279e49d4697750f837a56">§ </a></span>readInt64()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> InputStream::readInt64 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads eight bytes from the stream as a little-endian 64-bit value. </p>
<p>If the next eight bytes are byte1 to byte8, this returns (byte1 | (byte2 << 8) | (byte3 << 16) | (byte4 << 24) | (byte5 << 32) | (byte6 << 40) | (byte7 << 48) | (byte8 << 56)).</p>
<p>If the stream is exhausted partway through reading the bytes, this will return zero.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#a078351d61263e8e8141ccde1a0c07816" title="Writes a 64-bit integer to the stream in a little-endian byte order. ">OutputStream::writeInt64</a>, <a class="el" href="classInputStream.html#a8894f1c01c6e0de4b5dd9b9c1fe06c4b" title="Reads eight bytes from the stream as a big-endian 64-bit value. ">readInt64BigEndian</a> </dd></dl>
</div>
</div>
<a id="a8894f1c01c6e0de4b5dd9b9c1fe06c4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8894f1c01c6e0de4b5dd9b9c1fe06c4b">§ </a></span>readInt64BigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> InputStream::readInt64BigEndian </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads eight bytes from the stream as a big-endian 64-bit value. </p>
<p>If the next eight bytes are byte1 to byte8, this returns (byte8 | (byte7 << 8) | (byte6 << 16) | (byte5 << 24) | (byte4 << 32) | (byte3 << 40) | (byte2 << 48) | (byte1 << 56)).</p>
<p>If the stream is exhausted partway through reading the bytes, this will return zero.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#a5962dcaca71153338180ef0c17e11152" title="Writes a 64-bit integer to the stream in a big-endian byte order. ">OutputStream::writeInt64BigEndian</a>, <a class="el" href="classInputStream.html#a58941fd7cf4279e49d4697750f837a56" title="Reads eight bytes from the stream as a little-endian 64-bit value. ">readInt64</a> </dd></dl>
</div>
</div>
<a id="a46d7f191f1872bc27550db3fa0733f59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46d7f191f1872bc27550db3fa0733f59">§ </a></span>readFloat()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float InputStream::readFloat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads four bytes as a 32-bit floating point value. </p>
<p>The raw 32-bit encoding of the float is read from the stream as a little-endian int. If the stream is exhausted partway through reading the bytes, this will return zero. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#a0a1d967388deb957e573a8bfa0aede56" title="Writes a 32-bit floating point value to the stream in a binary format. ">OutputStream::writeFloat</a>, <a class="el" href="classInputStream.html#a31626a82ad48629a202135ac925ffecd" title="Reads eight bytes as a 64-bit floating point value. ">readDouble</a> </dd></dl>
</div>
</div>
<a id="a4d19fef152296085c477882e0650b011"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d19fef152296085c477882e0650b011">§ </a></span>readFloatBigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float InputStream::readFloatBigEndian </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads four bytes as a 32-bit floating point value. </p>
<p>The raw 32-bit encoding of the float is read from the stream as a big-endian int. If the stream is exhausted partway through reading the bytes, this will return zero. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#a84cb925582b87dc5c1f5e6d569a74208" title="Writes a 32-bit floating point value to the stream in a binary format. ">OutputStream::writeFloatBigEndian</a>, <a class="el" href="classInputStream.html#a7c7a2928053424caf51986d9e6fdaa35" title="Reads eight bytes as a 64-bit floating point value. ">readDoubleBigEndian</a> </dd></dl>
</div>
</div>
<a id="a31626a82ad48629a202135ac925ffecd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31626a82ad48629a202135ac925ffecd">§ </a></span>readDouble()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double InputStream::readDouble </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads eight bytes as a 64-bit floating point value. </p>
<p>The raw 64-bit encoding of the double is read from the stream as a little-endian int64. If the stream is exhausted partway through reading the bytes, this will return zero. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#af48e3b3934bf5b4624dcbe00989581a0" title="Writes a 64-bit floating point value to the stream in a binary format. ">OutputStream::writeDouble</a>, <a class="el" href="classInputStream.html#a46d7f191f1872bc27550db3fa0733f59" title="Reads four bytes as a 32-bit floating point value. ">readFloat</a> </dd></dl>
</div>
</div>
<a id="a7c7a2928053424caf51986d9e6fdaa35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c7a2928053424caf51986d9e6fdaa35">§ </a></span>readDoubleBigEndian()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double InputStream::readDoubleBigEndian </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads eight bytes as a 64-bit floating point value. </p>
<p>The raw 64-bit encoding of the double is read from the stream as a big-endian int64. If the stream is exhausted partway through reading the bytes, this will return zero. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#a03a42d49d4a1aba31b38a2069cbe18b0" title="Writes a 64-bit floating point value to the stream in a binary format. ">OutputStream::writeDoubleBigEndian</a>, <a class="el" href="classInputStream.html#a4d19fef152296085c477882e0650b011" title="Reads four bytes as a 32-bit floating point value. ">readFloatBigEndian</a> </dd></dl>
</div>
</div>
<a id="a3e3643991f4103c5cfc1b8c61c6a3e92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e3643991f4103c5cfc1b8c61c6a3e92">§ </a></span>readCompressedInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int InputStream::readCompressedInt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads an encoded 32-bit number from the stream using a space-saving compressed format. </p>
<p>For small values, this is more space-efficient than using <a class="el" href="classInputStream.html#a59eb456ebfbe9d4c7fdfd4c14337e19a" title="Reads four bytes from the stream as a little-endian 32-bit value. ">readInt()</a> and <a class="el" href="classOutputStream.html#a75f455e1a6e4da9190cd77bc01657622" title="Writes a 32-bit integer to the stream in a little-endian byte order. ">OutputStream::writeInt()</a> The format used is: number of significant bytes + up to 4 bytes in little-endian order. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#ac01d789588295c52ce4034bf792d9b20" title="Writes a condensed binary encoding of a 32-bit integer. ">OutputStream::writeCompressedInt()</a> </dd></dl>
</div>
</div>
<a id="af16acc8f2fd769adb559a781ece8e903"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af16acc8f2fd769adb559a781ece8e903">§ </a></span>readNextLine()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classString.html">String</a> InputStream::readNextLine </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a UTF-8 string from the stream, up to the next linefeed or carriage return. </p>
<p>This will read up to the next "\n" or "\r\n" or end-of-stream.</p>
<p>After this call, the stream's position will be left pointing to the next character following the line-feed, but the linefeeds aren't included in the string that is returned. </p>
</div>
</div>
<a id="abff18ad6e416d45f19d347abd3433665"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abff18ad6e416d45f19d347abd3433665">§ </a></span>readString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classString.html">String</a> InputStream::readString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a zero-terminated UTF-8 string from the stream. </p>
<p>This will read characters from the stream until it hits a null character or end-of-stream.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOutputStream.html#a63a79aac70bc3ad976cd3fb3a6d57ffd" title="Stores a string in the stream in a binary format. ">OutputStream::writeString</a>, <a class="el" href="classInputStream.html#aeb956ec5838d7f64153141ef51977c40" title="Tries to read the whole stream and turn it into a string. ">readEntireStreamAsString</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classBufferedInputStream.html#aedf621e448b5d415e68dc55eedbeebea">BufferedInputStream</a>.</p>
</div>
</div>
<a id="aeb956ec5838d7f64153141ef51977c40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb956ec5838d7f64153141ef51977c40">§ </a></span>readEntireStreamAsString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classString.html">String</a> InputStream::readEntireStreamAsString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to read the whole stream and turn it into a string. </p>
<p>This will read from the stream's current position until the end-of-stream. It can read from UTF-8 data, or UTF-16 if it detects suitable header-bytes. </p>
</div>
</div>
<a id="a7708d25af96e8d8b937a4642dcf55a23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7708d25af96e8d8b937a4642dcf55a23">§ </a></span>readIntoMemoryBlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t InputStream::readIntoMemoryBlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMemoryBlock.html">MemoryBlock</a> & </td>
<td class="paramname"><em>destBlock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ssize_t </td>
<td class="paramname"><em>maxNumBytesToRead</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>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>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">destBlock</td><td>the block to append the data onto </td></tr>
<tr><td class="paramname">maxNumBytesToRead</td><td>if this is a positive value, it sets a limit to the number of bytes that will be read - if it's negative, data will be read until the stream is exhausted. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes that were added to the memory block </dd></dl>
</div>
</div>
<a id="abf909e2de145df97221ab4deb2824c5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf909e2de145df97221ab4deb2824c5c">§ </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">virtual <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> InputStream::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">pure 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="classInputStream.html#ad7b4e8cec1e383657900e27bbcb3b06c" title="Tries to move the current read position of the stream. ">setPosition</a> </dd></dl>
<p>Implemented in <a class="el" href="classGZIPDecompressorInputStream.html#ac4c50d82834c802afbc17d9bb027fc04">GZIPDecompressorInputStream</a>, <a class="el" href="classMemoryInputStream.html#a31a7143622ba1c58be942b2c7d360a59">MemoryInputStream</a>, <a class="el" href="classFileInputStream.html#af6dddfc6ee214e6e7ac32b891c5d7209">FileInputStream</a>, <a class="el" href="classSubregionStream.html#afafd50358717a1740a4d5bbb8364be61">SubregionStream</a>, and <a class="el" href="classBufferedInputStream.html#a4bae1b9b3bbaf6f47859b726cf1b0454">BufferedInputStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryInputStream.html#aca7db79c18dbd0d425249aef22b22ba3">MemoryInputStream::getDataSize()</a>, and <a class="el" href="classFileInputStream.html#a45dc57c8101f565e505fed847723eb5d">FileInputStream::openedOk()</a>.</p>
</div>
</div>
<a id="ad7b4e8cec1e383657900e27bbcb3b06c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7b4e8cec1e383657900e27bbcb3b06c">§ </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">virtual bool InputStream::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">pure 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="classInputStream.html#abf909e2de145df97221ab4deb2824c5c" title="Returns the offset of the next byte that will be read from the stream. ">getPosition</a> </dd></dl>
<p>Implemented in <a class="el" href="classGZIPDecompressorInputStream.html#a3e24dc42a69696d11d5ec8b79fe5cd91">GZIPDecompressorInputStream</a>, <a class="el" href="classMemoryInputStream.html#a2eca865569cbeef5200efa07ec015c2b">MemoryInputStream</a>, <a class="el" href="classFileInputStream.html#a204dabd8c94c480fecdd55276f7125e7">FileInputStream</a>, <a class="el" href="classSubregionStream.html#a03d20081b8094f142d853b4f964d65e3">SubregionStream</a>, and <a class="el" href="classBufferedInputStream.html#ac71d4e069913c419f46b98322d5099c1">BufferedInputStream</a>.</p>
<p>Referenced by <a class="el" href="classMemoryInputStream.html#aca7db79c18dbd0d425249aef22b22ba3">MemoryInputStream::getDataSize()</a>, and <a class="el" href="classFileInputStream.html#a45dc57c8101f565e505fed847723eb5d">FileInputStream::openedOk()</a>.</p>
</div>
</div>
<a id="a7e3005cc6a58cd2ded6094dd6dd06542"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e3005cc6a58cd2ded6094dd6dd06542">§ </a></span>skipNextBytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void InputStream::skipNextBytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>numBytesToSkip</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads and discards a number of bytes from the stream. </p>
<p>Some input streams might implement this efficiently, but the base class will just keep reading data until the requisite number of bytes have been done. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__InputStream_8h.html">juce_InputStream.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|