Interface Swift_OutputByteStream
Implemented by | Swift_ByteStream_ArrayByteStream, Swift_FileStream, Swift_Transport_IoBuffer |
---|
An abstract means of reading data.
Classes implementing this interface may use a subsystem which requires less memory than working with large strings of data.
Public Methods
Method | Description | Defined By |
---|---|---|
read() | Reads $length bytes from the stream into a string and moves the pointer through the stream by $length. | Swift_OutputByteStream |
setReadPointer() | Move the internal read pointer to $byteOffset in the stream. | Swift_OutputByteStream |
Method Details
Reads $length bytes from the stream into a string and moves the pointer through the stream by $length.
If less bytes exist than are requested the remaining bytes are given instead. If no bytes are remaining at all, boolean false is returned.
public abstract string|bool read ( $length ) | ||
$length | int | |
throws | Swift_IoException |
---|
Move the internal read pointer to $byteOffset in the stream.
public abstract bool setReadPointer ( $byteOffset ) | ||
$byteOffset | int | |
throws | Swift_IoException |
---|