#include <juce_core.h>
The base class for streams that read data.
Input and output streams are used throughout the library - subclasses can override some or all of the virtual functions to implement their behaviour.
- See also
- OutputStream, MemoryInputStream, BufferedInputStream, FileInputStream
virtual juce::InputStream::~InputStream |
( |
| ) |
|
|
inlinevirtual |
juce::InputStream::InputStream |
( |
| ) |
|
|
inlineprotectednoexcept |
int64 InputStream::getNumBytesRemaining |
( |
| ) |
|
Returns the number of bytes available for reading, or a negative value if the remaining length is not known.
- See also
- getTotalLength
virtual int64 juce::InputStream::getPosition |
( |
| ) |
|
|
pure virtual |
virtual int64 juce::InputStream::getTotalLength |
( |
| ) |
|
|
pure virtual |
virtual bool juce::InputStream::isExhausted |
( |
| ) |
|
|
pure virtual |
virtual int juce::InputStream::read |
( |
void * |
destBuffer, |
|
|
int |
maxBytesToRead |
|
) |
| |
|
pure virtual |
Reads some data from the stream into a memory buffer.
This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).
- Parameters
-
destBuffer | the destination buffer for the data. This must not be null. |
maxBytesToRead | 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. |
- Returns
- the actual number of bytes that were read, which may be less than maxBytesToRead if the stream is exhausted before it gets that far
Implemented in juce::ZipFile::ZipInputStream, juce::GZIPDecompressorInputStream, juce::MemoryInputStream, juce::SubregionStream, juce::FileInputStream, and juce::BufferedInputStream.
bool InputStream::readBool |
( |
| ) |
|
|
virtual |
Reads a boolean from the stream. The bool is encoded as a single byte - non-zero for true, 0 for false. If the stream is exhausted, this will return false.
- See also
- OutputStream::writeBool
char InputStream::readByte |
( |
| ) |
|
|
virtual |
int InputStream::readCompressedInt |
( |
| ) |
|
|
virtual |
double InputStream::readDouble |
( |
| ) |
|
|
virtual |
Reads eight bytes as a 64-bit floating point value. 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.
- See also
- OutputStream::writeDouble, readFloat
double InputStream::readDoubleBigEndian |
( |
| ) |
|
|
virtual |
Reads eight bytes as a 64-bit floating point value. 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.
- See also
- OutputStream::writeDoubleBigEndian, readFloatBigEndian
String InputStream::readEntireStreamAsString |
( |
| ) |
|
|
virtual |
Tries to read the whole stream and turn it into a string.
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.
float InputStream::readFloat |
( |
| ) |
|
|
virtual |
Reads four bytes as a 32-bit floating point value. 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.
- See also
- OutputStream::writeFloat, readDouble
float InputStream::readFloatBigEndian |
( |
| ) |
|
|
virtual |
Reads four bytes as a 32-bit floating point value. 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.
- See also
- OutputStream::writeFloatBigEndian, readDoubleBigEndian
int InputStream::readInt |
( |
| ) |
|
|
virtual |
Reads four bytes from the stream as a little-endian 32-bit value.
If the next four bytes are byte1 to byte4, this returns (byte1 | (byte2 << 8) | (byte3 << 16) | (byte4 << 24)).
If the stream is exhausted partway through reading the bytes, this will return zero.
- See also
- OutputStream::writeInt, readIntBigEndian
int64 InputStream::readInt64 |
( |
| ) |
|
|
virtual |
Reads eight bytes from the stream as a little-endian 64-bit value.
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)).
If the stream is exhausted partway through reading the bytes, this will return zero.
- See also
- OutputStream::writeInt64, readInt64BigEndian
int64 InputStream::readInt64BigEndian |
( |
| ) |
|
|
virtual |
Reads eight bytes from the stream as a big-endian 64-bit value.
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)).
If the stream is exhausted partway through reading the bytes, this will return zero.
- See also
- OutputStream::writeInt64BigEndian, readInt64
int InputStream::readIntBigEndian |
( |
| ) |
|
|
virtual |
Reads four bytes from the stream as a big-endian 32-bit value.
If the next four bytes are byte1 to byte4, this returns (byte4 | (byte3 << 8) | (byte2 << 16) | (byte1 << 24)).
If the stream is exhausted partway through reading the bytes, this will return zero.
- See also
- OutputStream::writeIntBigEndian, readInt
size_t InputStream::readIntoMemoryBlock |
( |
MemoryBlock & |
destBlock, |
|
|
ssize_t |
maxNumBytesToRead = -1 |
|
) |
| |
|
virtual |
Reads from the stream and appends the data to a MemoryBlock.
- Parameters
-
destBlock | the block to append the data onto |
maxNumBytesToRead | 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. |
- Returns
- the number of bytes that were added to the memory block
String InputStream::readNextLine |
( |
| ) |
|
|
virtual |
Reads a UTF-8 string from the stream, up to the next linefeed or carriage return.
This will read up to the next "\n" or "\r\n" or end-of-stream.
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.
short InputStream::readShort |
( |
| ) |
|
|
virtual |
Reads two bytes from the stream as a little-endian 16-bit value. 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.
- See also
- OutputStream::writeShort, readShortBigEndian
short InputStream::readShortBigEndian |
( |
| ) |
|
|
virtual |
Reads two bytes from the stream as a little-endian 16-bit value. 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.
- See also
- OutputStream::writeShortBigEndian, readShort
String InputStream::readString |
( |
| ) |
|
|
virtual |
virtual bool juce::InputStream::setPosition |
( |
int64 |
newPosition | ) |
|
|
pure virtual |
void InputStream::skipNextBytes |
( |
int64 |
numBytesToSkip | ) |
|
|
virtual |
Reads and discards a number of bytes from the stream.
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.
The documentation for this class was generated from the following files: