read_bytes


Description:

[ Version ( since = "2.34" ) ]
public Bytes read_bytes (size_t count, Cancellable? cancellable = null) throws Error

Like read, this tries to read count bytes from the stream in a blocking fashion.

However, rather than reading into a user-supplied buffer, this will create a new Bytes containing the data that was read. This may be easier to use from language bindings.

If count is zero, returns a zero-length Bytes and does nothing. A value of count larger than g_maxssize will cause a g_io_error_invalid_argument error.

On success, a new Bytes is returned. It is not an error if the size of this object is not the same as the requested size, as it can happen e.g. near the end of a file. A zero-length Bytes 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 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 null is returned and throws is set accordingly.

Parameters:

this

a InputStream.

count

maximum number of bytes that will be read from the stream. Common values include 4096 and 8192.

cancellable

optional Cancellable object, null to ignore.

Returns:

a new Bytes, or null on error




2022 vala-language.org