read_all


Description:

public bool read_all (uint8[] buffer, out size_t bytes_read, Cancellable? cancellable = null) throws IOError

Tries to read buffer.length bytes from the stream into the buffer starting at buffer.

Will block during this read.

This function is similar to read, except it tries to read as many bytes as requested, only stopping on an error or end of stream.

On a successful read of buffer.length bytes, or if we reached the end of the stream, true is returned, and bytes_read is set to the number of bytes read into buffer.

If there is an error during the operation false is returned and throws is set to indicate the error status.

As a special exception to the normal conventions for functions that use Error, if this function returns false (and sets throws) then bytes_read will be set to the number of bytes that were successfully read before the error was encountered. This functionality is only available from C. If you need it from another language then you must write your own loop around read.

Parameters:

this

a InputStream.

buffer

a buffer to read data into (which should be at least count bytes long).

bytes_read

location to store the number of bytes that was read from the stream

cancellable

optional Cancellable object, null to ignore.

count

the number of bytes that will be read from the stream

Returns:

true on success, false if there was an error