The base class for streams that write data to some kind of destination. More...
Inherited by FileOutputStream, GZIPCompressorOutputStream, and MemoryOutputStream.
Public Member Functions | |
| virtual | ~OutputStream () |
| Destructor. | |
| virtual void | flush ()=0 |
| If the stream is using a buffer, this will ensure it gets written out to the destination. | |
| virtual bool | setPosition (int64 newPosition)=0 |
| Tries to move the stream's output position. | |
| virtual int64 | getPosition ()=0 |
| Returns the stream's current position. | |
| virtual bool | write (const void *dataToWrite, int howManyBytes)=0 |
| Writes a block of data to the stream. | |
| virtual void | writeByte (char byte) |
| Writes a single byte to the stream. | |
| virtual void | writeBool (bool boolValue) |
| Writes a boolean to the stream as a single byte. | |
| virtual void | writeShort (short value) |
| Writes a 16-bit integer to the stream in a little-endian byte order. | |
| virtual void | writeShortBigEndian (short value) |
| Writes a 16-bit integer to the stream in a big-endian byte order. | |
| virtual void | writeInt (int value) |
| Writes a 32-bit integer to the stream in a little-endian byte order. | |
| virtual void | writeIntBigEndian (int value) |
| Writes a 32-bit integer to the stream in a big-endian byte order. | |
| virtual void | writeInt64 (int64 value) |
| Writes a 64-bit integer to the stream in a little-endian byte order. | |
| virtual void | writeInt64BigEndian (int64 value) |
| Writes a 64-bit integer to the stream in a big-endian byte order. | |
| virtual void | writeFloat (float value) |
| Writes a 32-bit floating point value to the stream in a binary format. | |
| virtual void | writeFloatBigEndian (float value) |
| Writes a 32-bit floating point value to the stream in a binary format. | |
| virtual void | writeDouble (double value) |
| Writes a 64-bit floating point value to the stream in a binary format. | |
| virtual void | writeDoubleBigEndian (double value) |
| Writes a 64-bit floating point value to the stream in a binary format. | |
| virtual void | writeRepeatedByte (uint8 byte, int numTimesToRepeat) |
| Writes a byte to the output stream a given number of times. | |
| virtual void | writeCompressedInt (int value) |
| Writes a condensed binary encoding of a 32-bit integer. | |
| virtual void | writeString (const String &text) |
| Stores a string in the stream in a binary format. | |
| virtual void | writeText (const String &text, bool asUTF16, bool writeUTF16ByteOrderMark) |
| Writes a string of text to the stream. | |
| virtual int | writeFromInputStream (InputStream &source, int64 maxNumBytesToWrite) |
| Reads data from an input stream and writes it to this stream. | |
| void | setNewLineString (const String &newLineString) |
| Sets the string that will be written to the stream when the writeNewLine() method is called. | |
| const String & | getNewLineString () const noexcept |
| Returns the current new-line string that was set by setNewLineString(). | |
Protected Member Functions | |
| OutputStream () | |
The base class for streams that write data to some kind of destination.
Input and output streams are used throughout the library - subclasses can override some or all of the virtual functions to implement their behaviour.
| OutputStream::OutputStream | ( | ) | [protected] |
| virtual OutputStream::~OutputStream | ( | ) | [virtual] |
Destructor.
Some subclasses might want to do things like call flush() during their destructors.
| virtual void OutputStream::flush | ( | ) | [pure virtual] |
If the stream is using a buffer, this will ensure it gets written out to the destination.
Implemented in FileOutputStream, GZIPCompressorOutputStream, and MemoryOutputStream.
| virtual bool OutputStream::setPosition | ( | int64 | newPosition ) | [pure virtual] |
Tries to move the stream's output position.
Not all streams will be able to seek to a new position - this will return false if it fails to work.
Implemented in FileOutputStream, GZIPCompressorOutputStream, and MemoryOutputStream.
| virtual int64 OutputStream::getPosition | ( | ) | [pure virtual] |
Returns the stream's current position.
Implemented in FileOutputStream, GZIPCompressorOutputStream, and MemoryOutputStream.
| virtual bool OutputStream::write | ( | const void * | dataToWrite, |
| int | howManyBytes | ||
| ) | [pure virtual] |
Writes a block of data to the stream.
When creating a subclass of OutputStream, this is the only write method that needs to be overloaded - the base class has methods for writing other types of data which use this to do the work.
Implemented in FileOutputStream, GZIPCompressorOutputStream, and MemoryOutputStream.
| virtual void OutputStream::writeByte | ( | char | byte ) | [virtual] |
Writes a single byte to the stream.
| virtual void OutputStream::writeBool | ( | bool | boolValue ) | [virtual] |
Writes a boolean to the stream as a single byte.
This is encoded as a binary byte (not as text) with a value of 1 or 0.
| virtual void OutputStream::writeShort | ( | short | value ) | [virtual] |
Writes a 16-bit integer to the stream in a little-endian byte order.
This will write two bytes to the stream: (value & 0xff), then (value >> 8).
| virtual void OutputStream::writeShortBigEndian | ( | short | value ) | [virtual] |
Writes a 16-bit integer to the stream in a big-endian byte order.
This will write two bytes to the stream: (value >> 8), then (value & 0xff).
| virtual void OutputStream::writeInt | ( | int | value ) | [virtual] |
Writes a 32-bit integer to the stream in a little-endian byte order.
| virtual void OutputStream::writeIntBigEndian | ( | int | value ) | [virtual] |
Writes a 32-bit integer to the stream in a big-endian byte order.
| virtual void OutputStream::writeInt64 | ( | int64 | value ) | [virtual] |
Writes a 64-bit integer to the stream in a little-endian byte order.
| virtual void OutputStream::writeInt64BigEndian | ( | int64 | value ) | [virtual] |
Writes a 64-bit integer to the stream in a big-endian byte order.
| virtual void OutputStream::writeFloat | ( | float | value ) | [virtual] |
Writes a 32-bit floating point value to the stream in a binary format.
The binary 32-bit encoding of the float is written as a little-endian int.
| virtual void OutputStream::writeFloatBigEndian | ( | float | value ) | [virtual] |
Writes a 32-bit floating point value to the stream in a binary format.
The binary 32-bit encoding of the float is written as a big-endian int.
| virtual void OutputStream::writeDouble | ( | double | value ) | [virtual] |
Writes a 64-bit floating point value to the stream in a binary format.
The eight raw bytes of the double value are written out as a little-endian 64-bit int.
| virtual void OutputStream::writeDoubleBigEndian | ( | double | value ) | [virtual] |
Writes a 64-bit floating point value to the stream in a binary format.
The eight raw bytes of the double value are written out as a big-endian 64-bit int.
| virtual void OutputStream::writeRepeatedByte | ( | uint8 | byte, |
| int | numTimesToRepeat | ||
| ) | [virtual] |
Writes a byte to the output stream a given number of times.
Reimplemented in FileOutputStream, and MemoryOutputStream.
| virtual void OutputStream::writeCompressedInt | ( | int | value ) | [virtual] |
Writes a condensed binary encoding of a 32-bit integer.
If you're storing a lot of integers which are unlikely to have very large values, this can save a lot of space, because values under 0xff will only take up 2 bytes, under 0xffff only 3 bytes, etc.
The format used is: number of significant bytes + up to 4 bytes in little-endian order.
| virtual void OutputStream::writeString | ( | const String & | text ) | [virtual] |
Stores a string in the stream in a binary format.
This isn't the method to use if you're trying to append text to the end of a text-file! It's intended for storing a string so that it can be retrieved later by InputStream::readString().
It writes the string to the stream as UTF8, including the null termination character.
For appending text to a file, instead use writeText, or operator<<
| virtual void OutputStream::writeText | ( | const String & | text, |
| bool | asUTF16, | ||
| bool | writeUTF16ByteOrderMark | ||
| ) | [virtual] |
Writes a string of text to the stream.
It can either write the text as UTF-8 or UTF-16, and can also add the UTF-16 byte-order-mark bytes (0xff, 0xfe) to indicate the endianness (these should only be used at the start of a file).
The method also replaces '\n' characters in the text with '\r\n'.
| virtual int OutputStream::writeFromInputStream | ( | InputStream & | source, |
| int64 | maxNumBytesToWrite | ||
| ) | [virtual] |
Reads data from an input stream and writes it to this stream.
| source | the stream to read from |
| maxNumBytesToWrite | the number of bytes to read from the stream (if this is less than zero, it will keep reading until the input is exhausted) |
Reimplemented in MemoryOutputStream.
| void OutputStream::setNewLineString | ( | const String & | newLineString ) |
Sets the string that will be written to the stream when the writeNewLine() method is called.
By default this will be set the the value of NewLine::getDefault().
| const String& OutputStream::getNewLineString | ( | ) | const |
Returns the current new-line string that was set by setNewLineString().
