PHP Class Protobuf\Stream

Author: Fabio B. Silva ([email protected])

Public Methods

Method	Description
__construct ( resource $stream, integer $size = null )
__destruct ( )	Closes the stream when the destructed
__toString ( )
create ( ) : Stream	Create a new stream.
eof ( ) : boolean	Returns true if the stream is at the end of the stream.
fromString ( string $resource = '', integer $size = null ) : Stream	Create a new stream from a string.
getContents ( ) : string	Returns the remaining contents of the stream as a string.
getSize ( ) : integer \| null	Get the size of the stream
read ( integer $length ) : string	Read data from the stream
readStream ( integer $length ) : Stream	Read stream
seek ( integer $offset, integer $whence = SEEK_SET )	Seek to a position in the stream
tell ( ) : integer	Returns the current position of the file read/write pointer
wrap ( Stream \| resource \| string $resource = '', integer $size = null ) : Stream	Wrap the input resource in a stream object.
write ( string $bytes, integer $length ) : integer	Write data to the stream
writeStream ( Stream $stream, integer $length ) : integer	Write stream

public __construct ( resource $stream, integer $size = null )
$stream	resource
$size	integer

Closes the stream when the destructed

public __destruct ( )

public __toString ( )

Create a new stream.

public static create ( ) : Stream
return	Stream

Returns true if the stream is at the end of the stream.

public eof ( ) : boolean
return	boolean

Create a new stream from a string.

public static fromString ( string $resource = '', integer $size = null ) : Stream
$resource	string
$size	integer
return	Stream

Returns the remaining contents of the stream as a string.

public getContents ( ) : string
return	string

Get the size of the stream

public getSize ( ) : integer \| null
return	integer \| null	Returns the size in bytes if known

Read data from the stream

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

Read stream

public readStream ( integer $length ) : Stream
$length	integer
return	Stream

Seek to a position in the stream

public seek ( integer $offset, integer $whence = SEEK_SET )
$offset	integer
$whence	integer

Returns the current position of the file read/write pointer

public tell ( ) : integer
return	integer

Wrap the input resource in a stream object.

public static wrap ( Stream \| resource \| string $resource = '', integer $size = null ) : Stream
$resource	Stream \| resource \| string
$size	integer
return	Stream

Write data to the stream

public write ( string $bytes, integer $length ) : integer
$bytes	string
$length	integer
return	integer

Write stream

public writeStream ( Stream $stream, integer $length ) : integer
$stream	Stream
$length	integer
return	integer