Gio.InputStream.prototype.read

function read(buffer: ByteArray, cancellable: Gio.Cancellable): Number(gssize) {
    // Gjs wrapper for g_input_stream_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.IOErrorEnum.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 count is zero), but never otherwise.

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.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.