InputStream.read

Tries to read count bytes from the stream into the buffer starting at buffer. Will block during this read.

If count is zero returns zero and does nothing. A value of count larger than G_MAXSSIZE will cause a gio.types.IOErrorEnum.InvalidArgument error.

On success, the number of bytes read into the buffer is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. near the end of a file. Zero is returned on end of file (or if count is zero), but never otherwise.

The returned buffer is not a nul-terminated string, it can contain nul bytes at any position, and this function doesn't nul-terminate the buffer.

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error gio.types.IOErrorEnum.Cancelled will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

On error -1 is returned and error is set accordingly.

class InputStream
ptrdiff_t
read

Parameters

buffer ubyte[]

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

cancellable gio.cancellable.Cancellable

optional #GCancellable object, null to ignore.

Return Value

Type: ptrdiff_t

Number of bytes read, or -1 on error, or 0 on end of file.