|
JUCE
|
The base class for streams that read data. More...
Public Member Functions | |
| virtual | ~InputStream ()=default |
| Destructor. More... | |
| virtual int64 | getTotalLength ()=0 |
| Returns the total number of bytes available for reading in this stream. More... | |
| int64 | getNumBytesRemaining () |
| Returns the number of bytes available for reading, or a negative value if the remaining length is not known. More... | |
| virtual bool | isExhausted ()=0 |
| Returns true if the stream has no more data to read. More... | |
| virtual int | read (void *destBuffer, int maxBytesToRead)=0 |
| Reads some data from the stream into a memory buffer. More... | |
| ssize_t | read (void *destBuffer, size_t maxBytesToRead) |
| virtual char | readByte () |
| Reads a byte from the stream. More... | |
| virtual bool | readBool () |
| Reads a boolean from the stream. More... | |
| virtual short | readShort () |
| Reads two bytes from the stream as a little-endian 16-bit value. More... | |
| virtual short | readShortBigEndian () |
| Reads two bytes from the stream as a little-endian 16-bit value. More... | |
| virtual int | readInt () |
| Reads four bytes from the stream as a little-endian 32-bit value. More... | |
| virtual int | readIntBigEndian () |
| Reads four bytes from the stream as a big-endian 32-bit value. More... | |
| virtual int64 | readInt64 () |
| Reads eight bytes from the stream as a little-endian 64-bit value. More... | |
| virtual int64 | readInt64BigEndian () |
| Reads eight bytes from the stream as a big-endian 64-bit value. More... | |
| virtual float | readFloat () |
| Reads four bytes as a 32-bit floating point value. More... | |
| virtual float | readFloatBigEndian () |
| Reads four bytes as a 32-bit floating point value. More... | |
| virtual double | readDouble () |
| Reads eight bytes as a 64-bit floating point value. More... | |
| virtual double | readDoubleBigEndian () |
| Reads eight bytes as a 64-bit floating point value. More... | |
| virtual int | readCompressedInt () |
| Reads an encoded 32-bit number from the stream using a space-saving compressed format. More... | |
| virtual String | readNextLine () |
| Reads a UTF-8 string from the stream, up to the next linefeed or carriage return. More... | |
| virtual String | readString () |
| Reads a zero-terminated UTF-8 string from the stream. More... | |
| virtual String | readEntireStreamAsString () |
| Tries to read the whole stream and turn it into a string. More... | |
| virtual size_t | readIntoMemoryBlock (MemoryBlock &destBlock, ssize_t maxNumBytesToRead=-1) |
| Reads from the stream and appends the data to a MemoryBlock. More... | |
| virtual int64 | getPosition ()=0 |
| Returns the offset of the next byte that will be read from the stream. More... | |
| virtual bool | setPosition (int64 newPosition)=0 |
| Tries to move the current read position of the stream. More... | |
| virtual void | skipNextBytes (int64 numBytesToSkip) |
| Reads and discards a number of bytes from the stream. More... | |
Protected Member Functions | |
| InputStream ()=default | |
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.
|
virtualdefault |
Destructor.
|
protecteddefault |
|
pure virtual |
Returns the total number of bytes available for reading in this stream.
Note that this is the number of bytes available from the start of the stream, not from the current position.
If the size of the stream isn't actually known, this will return -1.
Implemented in WebInputStream, MemoryInputStream, GZIPDecompressorInputStream, FileInputStream, BufferedInputStream, and SubregionStream.
Referenced by MemoryInputStream::getDataSize(), and FileInputStream::openedOk().
| int64 InputStream::getNumBytesRemaining | ( | ) |
Returns the number of bytes available for reading, or a negative value if the remaining length is not known.
|
pure virtual |
Returns true if the stream has no more data to read.
Implemented in WebInputStream, MemoryInputStream, GZIPDecompressorInputStream, BufferedInputStream, FileInputStream, and SubregionStream.
Referenced by MemoryInputStream::getDataSize(), and FileInputStream::openedOk().
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).
| 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. |
Implemented in WebInputStream, MemoryInputStream, GZIPDecompressorInputStream, BufferedInputStream, FileInputStream, and SubregionStream.
Referenced by MemoryInputStream::getDataSize(), and FileInputStream::openedOk().
| ssize_t InputStream::read | ( | void * | destBuffer, |
| size_t | maxBytesToRead | ||
| ) |
|
virtual |
Reads a byte from the stream.
If the stream is exhausted, this will return zero.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
virtual |
Reads an encoded 32-bit number from the stream using a space-saving compressed format.
For small values, this is more space-efficient than using readInt() and OutputStream::writeInt() The format used is: number of significant bytes + up to 4 bytes in little-endian order.
|
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.
|
virtual |
Reads a zero-terminated UTF-8 string from the stream.
This will read characters from the stream until it hits a null character or end-of-stream.
Reimplemented in BufferedInputStream.
|
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.
|
virtual |
Reads from the stream and appends the data to a MemoryBlock.
| 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. |
|
pure virtual |
Returns the offset of the next byte that will be read from the stream.
Implemented in WebInputStream, MemoryInputStream, GZIPDecompressorInputStream, FileInputStream, BufferedInputStream, and SubregionStream.
Referenced by MemoryInputStream::getDataSize(), and FileInputStream::openedOk().
|
pure virtual |
Tries to move the current read position of the stream.
The position is an absolute number of bytes from the stream's start.
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.
Implemented in WebInputStream, MemoryInputStream, GZIPDecompressorInputStream, FileInputStream, BufferedInputStream, and SubregionStream.
Referenced by MemoryInputStream::getDataSize(), and FileInputStream::openedOk().
|
virtual |
Reads and discards a number of bytes from the stream.
Some input streams might implement this more efficiently, but the base class will just keep reading data until the requisite number of bytes have been done. For large skips it may be quicker to call setPosition() with the required position.
Reimplemented in MemoryInputStream.
Referenced by MemoryInputStream::getDataSize().
1.8.13