Interface Swift_CharacterStream

An abstract means of reading and writing data in terms of characters as opposed to bytes. Classes implementing this interface may use a subsystem which requires less memory than working with large strings of data.

Direct known implementers

Swift_CharacterStream_ArrayCharacterStream, Swift_CharacterStream_NgCharacterStream

Package: Swift\CharacterStream
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/CharacterStream.php

Methods summary

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

Packages

Classes

Interfaces

Interface Swift_CharacterStream

Direct known implementers

Methods summary

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Magic methods summary