Swift_OutputByteStream Interface Reference

Inheritance diagram for Swift_OutputByteStream:

Public Member Functions
	read ($length)
	setReadPointer ($byteOffset)

Detailed Description

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.

Author

Chris Corbyn

Definition at line 19 of file OutputByteStream.php.

Member Function Documentation

read

(

$length

)

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.

Parameters

int

$length

Exceptions

Swift_IoException

Returns

string|bool

Implemented in Swift_Transport_StreamBuffer, Swift_ByteStream_FileByteStream, and Swift_ByteStream_ArrayByteStream.

Referenced by Swift_Mime_SimpleMimeEntity\_readStream(), Swift_Signers_SMimeSigner\copyFromOpenSSLOutput(), Swift_Mime_ContentEncoder_Base64ContentEncoder\encodeByteStream(), Swift_Mime_ContentEncoder_RawContentEncoder\encodeByteStream(), Swift_Mime_ContentEncoder_NativeQpContentEncoder\encodeByteStream(), Swift_Mime_ContentEncoder_PlainContentEncoder\encodeByteStream(), Swift_CharacterStream_ArrayCharacterStream\importByteStream(), Swift_CharacterStream_NgCharacterStream\importByteStream(), Swift_KeyCache_ArrayKeyCache\importFromByteStream(), Swift_KeyCache_DiskKeyCache\importFromByteStream(), and Swift_Signers_SMimeSigner\streamToMime().

setReadPointer

(

$byteOffset

)

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

Parameters

int

$byteOffset

Exceptions

Swift_IoException

Returns

bool

Implemented in Swift_Transport_StreamBuffer, Swift_ByteStream_ArrayByteStream, and Swift_ByteStream_FileByteStream.

Referenced by Swift_Mime_SimpleMimeEntity\_readStream(), Swift_CharacterStream_NgCharacterStream\importByteStream(), and Swift_Signers_SMimeSigner\streamToMime().