Documentation

Swift_OutputByteStream

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.

Tags
author

Chris Corbyn

Table of Contents

read()  : string|bool
Reads $length bytes from the stream into a string and moves the pointer through the stream by $length.
setReadPointer()  : bool
Move the internal read pointer to $byteOffset in the stream.

Methods

read()

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

public read(int $length) : string|bool

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

Parameters
$length : int
Tags
throws
Swift_IoException
Return values
string|bool

setReadPointer()

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

public setReadPointer(int $byteOffset) : bool
Parameters
$byteOffset : int
Tags
throws
Swift_IoException
Return values
bool

Search results