PHP Interface Swift_CharacterStream, Halite

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

Author: Chris Corbyn

Public Methods

Method	Description
flushContents ( )	Empty the stream and reset the internal pointer.
importByteStream ( Swift_OutputByteStream $os )	Overwrite this character stream using the byte sequence in the byte stream.
importString ( string $string )	Import a string a bytes into this CharacterStream, overwriting any existing data in the stream.
read ( integer $length ) : string	Read $length characters from the stream and move the internal pointer $length further into the stream.
readBytes ( integer $length ) : int[]	Read $length characters from the stream and return a 1-dimensional array containing there octet values.
setCharacterReaderFactory ( Swift_CharacterReaderFactory $factory )	Set the CharacterReaderFactory for multi charset support.
setCharacterSet ( string $charset )	Set the character set used in this CharacterStream.
setPointer ( integer $charOffset )	Move the internal pointer to $charOffset in the stream.
write ( string $chars )	Write $chars to the end of the stream.

Empty the stream and reset the internal pointer.

public flushContents ( )

Overwrite this character stream using the byte sequence in the byte stream.

public importByteStream ( Swift_OutputByteStream $os )
$os	Swift_OutputByteStream	output stream to read from

Import a string a bytes into this CharacterStream, overwriting any existing data in the stream.

public importString ( string $string )
$string	string

Read $length characters from the stream and move the internal pointer $length further into the stream.

public read ( integer $length ) : string
$length	integer
return	string

Read $length characters from the stream and return a 1-dimensional array containing there octet values.

public readBytes ( integer $length ) : int[]
$length	integer
return	int[]

Set the CharacterReaderFactory for multi charset support.

public setCharacterReaderFactory ( Swift_CharacterReaderFactory $factory )
$factory	Swift_CharacterReaderFactory

Set the character set used in this CharacterStream.

public setCharacterSet ( string $charset )
$charset	string

Move the internal pointer to $charOffset in the stream.

public setPointer ( integer $charOffset )
$charOffset	integer

Write $chars to the end of the stream.

public write ( string $chars )
$chars	string