SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND


Platform::Io
Class ByteArrayStream

NonCopyableType
   |
   +-IStreamHandler
        |
        +-ByteArrayStream

Implemented in:
Platform.Io.IStreamHandler.h

class ByteArrayStream:
public IStreamHandler

Provides streaming of bytes from an input ByteArray into output ByteArray.

See Also:
IStreamHandler

Field Summarycollapse
const ByteArray* in
          Input stream.
ByteArray* out
          Output stream.
mutable Int position
          Position within input stream.

Constructor Summarycollapse
ByteArrayStream(const ByteArray* inByteArray, ByteArray* outByteArray)
          Creates a ByteArrayStream with the specified input and output ByteArrays.

Method Summarycollapse
Bool avail() const
          Tests whether a byte can be retrieved from the input stream.
Byte get() const
          Retrieves a byte from the input stream.
Void put(Byte value)
          Stores a byte in the output stream.

Methods inherited from class IStreamHandlercollapse
avail, flush, get, put

 

Field Detail

in

const ByteArray* in

Input stream.


out

ByteArray* out

Output stream.


position

mutable Int position

Position within input stream. Incremented with each byte retrieved.

 

Constructor Detail

ByteArrayStream[inline]

ByteArrayStream(const ByteArray* inByteArray, ByteArray* outByteArray)

Creates a ByteArrayStream with the specified input and output ByteArrays.

Parameters:
inByteArray - input stream
outByteArray - output stream

 

Method Detail

avail[virtual, inline]

Bool avail() const

Tests whether a byte can be retrieved from the input stream.

Returns:
True if a byte can be retrieved by the subsequent get() method, False otherwise
Implements:
IStreamHandler::avail

get[virtual, inline]

Byte get() const

Retrieves a byte from the input stream.

Returns:
a byte from the input stream
Implements:
IStreamHandler::get

put[virtual, inline]

Void put(Byte value)

Stores a byte in the output stream.

Parameters:
value - the value to store in the output stream
Implements:
IStreamHandler::put


SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND