[ CCode ( vfunc_name = "read_fn" ) ]
public abstract ssize_t read (uint8[] buffer, 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.

If count is zero returns zero and does nothing. A value of buffer.length larger than g_maxssize will cause a g_io_error_invalid_argument 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 buffer.length 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 g_io_error_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 throws is set accordingly.



a InputStream.


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


optional Cancellable object, null to ignore.


the number of bytes that will be read from the stream


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