An OutputByteStream which specifically reads from a file.

Classes implementing this interface may use a subsystem which requires less memory than working with large strings of data.

package Swift
subpackage ByteStream
author Chris Corbyn

 Methods

Get the complete path to the file.

getPath() : string

Returns

string

Reads $length bytes from the stream into a string and moves the pointer through the stream by $length.

read(int $length) : string
Inherited

If less bytes exist than are requested the remaining bytes are given instead. If no bytes are remaining at all, boolean false is returned.

inherited_from \Swift_OutputByteStream::read()

Parameters

$length

int

Exceptions

\Swift_IoException

Returns

string

Move the internal read pointer to $byteOffset in the stream.

setReadPointer(int $byteOffset) : boolean
Inherited
inherited_from \Swift_OutputByteStream::setReadPointer()

Parameters

$byteOffset

int

Exceptions

\Swift_IoException

Returns

boolean