Initializes an empty memory stream. As data is written the stream will grow its internal memory storage automatically.
Initializes a stream with some initial capacity. If more bytes than capacity is written, the stream will grow its internal memory storage.
Number of bytes to initially allocate for the internal memory storage.
OptionalisInternalConstructor: booleanGets the access mode of the stream.
Checks whether the stream reads/writes from a file system.
Checks whether the stream reads/writes from memory.
Determines if the stream is readable.
Checks whether the stream is valid.
Determines if the stream is writable.
Gets the name of the stream.
Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream.
Aligns the read/write cursor to a byte boundary. count determines the alignment in bytes. Note the requested alignment might
not be achieved if count > 1 and it would move the cursor past the capacity of the buffer, as the cursor will be clamped to
buffer end regardless of alignment.
Optionalcount: numberCreates a copy of this stream.
OptionalcopyData: boolean
If true the internal stream data will be copied as well, otherwise it will just reference the data from the original stream (in which case the caller must ensure the original stream outlives the clone). This is not relevant for file streams.
Close the stream. This makes further operations invalid.
Read count bytes from both streams and determines if both streams are byte-wise identical.
The stream positions for both streams will be offset by count and must be manually reset.
Number of bytes to compare.
True if identical.
Returns true if the stream has reached the end.
Flushes any cached written data to the actual stream destination.
Returns a vector of bytes containing the entire stream.
OptionalseekToStart: boolean
If true, will seek the stream to the start before reading.
Byte data.
Returns a string containing the entire stream.
String data encoded as UTF-8.
Reads a bool value from the stream
The value
Reads a double value from the stream
The value
Reads a float value from the stream
The value
Reads an int16 value from the stream
The value
Reads an int32 value from the stream
The value
Reads an int64 value from the stream
The value
Reads an int8 value from the stream
The value
Reads a uint16 value from the stream
The value
Reads a uint32 value from the stream
The value
Reads a uint64 value from the stream
The value
Reads a uint8 value from the stream
The value
This will effectively change the size of the memory stream. The internal buffer might grow depending on the new size, but it won't shrink. Useful for when writing the memory directly into the internal buffer.
Repositions the read point to a specified byte.
Skip a defined number of bytes. This can also be a negative value, in which case the file pointer rewinds a defined number of bytes.
Returns the current byte offset from beginning.
Writes the contents of the provided array into the stream at the current cursor location and advances the cursor.
Array of data to write.
Number of bytes actually written.
Writes a bool value to the stream
The value
Writes a double value to the stream
The value
Writes a float value to the string
The value
Writes an int16 value to the stream
The value
Writes an int32 value to the stream
The value
Writes an int64 value to the stream
The value
Writes an int8 value to the stream
The value
Read count bytes from the stream and writes and advance both the readStream and this stream's cursor.
Number of bytes to write.
Number of bytes actually written.
Writes the provided narrow string to the steam. String is convered to the required encoding before being written.
String containing narrow characters to write, encoded as UTF8.
Optionalencoding: EnumValue<StringEncoding>
Encoding to convert the string to before writing.
OptionalisWritingBOM: booleanWrites a uint16 value to the stream
The value
Writes a uint32 value to the stream
The value
Writes a uint64 value to the stream
The value
Writes a uint8 value to the stream
The value
Data stream for handling data from memory.