Interface IStreamComponent
interface IStreamComponent
Extends com.amazon.apmf.IStandard
Not implemented. This content describes future functionality.
Implementation of this interface provides functionality
for reading and writing binary data to and from streams.
This includes converting between binary and text representations.
Methods
makeTextInputStream()
Not implemented. This content describes future functionality. Converts a binary input stream to a text input stream using the specified encoding.ITextInputStream*makeTextInputStream(IBinaryInputStream*stream,stringencoding,ErrorModemode)
Parameters
stream
IBinaryInputStream* — Required
The binary input stream to read from.
encoding
string — Required
The character encoding to use for the text stream.
mode
ErrorMode — Required
The error mode to use for encoding errors.
Returns
ITextInputStream*
A text input stream for reading from the binary stream.
Throws
UnsupportedEncodingError— when the encoding is not supported.IoError— when error occurs during stream processing.
makeTextOutputStream()
Not implemented. This content describes future functionality. Converts a byte array to a text output stream using the specified encoding.ITextOutputStream*makeTextOutputStream(IBinaryOutputStream*stream,stringencoding)
Parameters
stream
IBinaryOutputStream* — Required
The binary output stream to write to.
encoding
string — Required
The character encoding to use for the text stream.
Returns
ITextOutputStream*
A text output stream for writing to the binary stream.
Throws
UnsupportedEncodingError— when the encoding is not supported.IoError— when error occurs during stream processing.
readAll()
Not implemented. This content describes future functionality. Reads all data from a binary input stream and returns it as a byte array.i8[]readAll(IBinaryInputStream*stream)
Parameters
stream
IBinaryInputStream* — Required
The binary input stream to read from.
Returns
i8[]
A byte array containing all the data read from the stream.
Throws
IoError— when error occurs during reading from an input stream.
writeAll()
Not implemented. This content describes future functionality. Writes all data from a byte array to a binary output stream.i32writeAll(IBinaryOutputStream*stream,i8[]data)
Parameters
stream
IBinaryOutputStream* — Required
The binary output stream to write to.
data
i8[] — Required
The byte array containing data to be written.
Returns
i32
The total number of bytes written to the stream.
Throws
IoError— when error occurs during writing to output stream.
