[19:7] extends: object
GInputStream is a base class for implementing streaming input. It has
functions to read from a stream ([method@Gio.InputStream.read]), to close a
stream ([method@Gio.InputStream.close]) and to skip some content
([method@Gio.InputStream.skip]). To copy the content of an input stream to an
output stream without manually handling the reads and writes, use
[method@Gio.OutputStream.splice]. See the documentation for
[class@Gio.IOStream] for details of thread safety of streaming APIs. All of
these functions have async variants too.
GInputStream (Handle = null)
Creates a new
InputStreamby wrapping a native handle or another wrapper.
Handle is the native handle or another wrapper whose handle to adopt.toNativeHandle (Source)
Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from
fn.call(...), another generated wrapper exposinghandle(), or null. Returns null when the argument carries no pointer.
Source is the raw handle, raw buffer, wrapper, or null.A raw pointer carrier or null when no pointer is present.getLib ()
Returns the opened native library for this generated wrapper.
The opened native library.handle ()
Returns the wrapped NativeHandle.
The wrapped NativeHandle.isNull ()
Returns true when the wrapped handle is null.
A bool.describe ()
Returns a small string for debugging generated wrappers.
A string.asObject ()
Wraps this handle as
GObject.
A GObject object.clear_pending ()
Clears the pending flag on @stream.
None.close (object cancellable)
Closes the stream, releasing resources related to it. Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error. Streams will be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible. Some streams might keep the backing store of the stream (e.g. a file descriptor) open after the stream is closed. See the documentation for the individual stream for details. On failure the first error that happened will be reported, but the close operation will finish as much as possible. A stream that failed to close will still return %G_IO_ERROR_CLOSED for all operations. Still, it is important to check and report the error to the user. 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. Cancelling a close will still leave the stream closed, but some streams can use a faster close that doesn't block to e.g. check errors.
cancellable is optional #GCancellable object, %NULL to ignore..%TRUE on success, %FALSE on failure.close_async (int io_priority, object cancellable, user_data)
Requests an asynchronous closes of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation. For behaviour details see g_input_stream_close(). The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all.
io_priority is the I/O priority of the request.cancellable is optional cancellable object.callback is a #GAsyncReadyCallback to call when the request is satisfied.user_data is the data to pass to callback function.None.close_finish (object result)
Finishes closing a stream asynchronously, started from g_input_stream_close_async().
result is a #GAsyncResult..%TRUE if the stream was closed successfully..has_pending ()
Checks if an input stream has pending actions.
%TRUE if @stream has pending actions..is_closed ()
Checks if an input stream is closed.
%TRUE if the stream is closed..read (int count, object cancellable)
Tries to read @count bytes from the stream into the buffer starting at
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 %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 @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 theIf @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 @error is set accordingly.buffer is a buffer to read data into (which should be at least count bytes long)..count is the number of bytes that will be read from the stream.cancellable is optional #GCancellable object, %NULL to ignore..Number of bytes read, or -1 on error, or 0 on end of file..read_all (int count, object cancellable)
Tries to read @count bytes from the stream into the buffer starting at
Will block during this read. This function is similar to g_input_stream_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 @count bytes, or if we reached the end of the stream, %TRUE is returned, and @bytes_read is set to the number of bytes read intoIf there is an error during the operation %FALSE is returned andis set to indicate the error status. As a special exception to the normal conventions for functions that use #GError, if this function returns %FALSE (and sets @error) 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 g_input_stream_read().buffer is a buffer to read data into (which should be at least count bytes long)..count is the number of bytes that will be read from the stream.bytes_read is location to store the number of bytes that was read from the stream.cancellable is optional #GCancellable object, %NULL to ignore..%TRUE on success, %FALSE if there was an error.read_all_async (int count, int io_priority, object cancellable, user_data)
Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. This is the asynchronous equivalent of [method@InputStream.read_all]. Call [method@InputStream.read_all_finish] to collect the result. Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is %G_PRIORITY_DEFAULT.
buffer is a buffer to read data into (which should be at least count bytes long).count is the number of bytes that will be read from the stream.io_priority is the I/O priority of the request.cancellable is optional #GCancellable object, %NULL to ignore.callback is a #GAsyncReadyCallback to call when the request is satisfied.user_data is the data to pass to callback function.None.read_all_finish (object result)
Finishes an asynchronous stream read operation started with [method@InputStream.read_all_async]. As a special exception to the normal conventions for functions that use #GError, if this function returns %FALSE (and sets @error) 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 g_input_stream_read_async().
result is a #GAsyncResult.bytes_read is location to store the number of bytes that was read from the stream.%TRUE on success, %FALSE if there was an error.read_async (int count, int io_priority, object cancellable, user_data)
Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. When the operation is finished @callback will be called. You can then call g_input_stream_read_finish() to get the result of the operation. During an async request no other sync and async calls are allowed on @stream, and will result in %G_IO_ERROR_PENDING errors. A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error. On success, the number of bytes read into the buffer will be passed to the callback. 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, but generally we try to read as many bytes as requested. Zero is returned on end of file (or if @count is zero), but never otherwise. Any outstanding i/o request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is %G_PRIORITY_DEFAULT. The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all.
buffer is a buffer to read data into (which should be at least count bytes long)..count is the number of bytes that will be read from the stream.io_priority is the I/O priority of the request..cancellable is optional #GCancellable object, %NULL to ignore..callback is a #GAsyncReadyCallback to call when the request is satisfied.user_data is the data to pass to callback function.None.read_bytes (int count, object cancellable)
Like g_input_stream_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 #GBytes containing the data that was read. This may be easier to use from language bindings. If count is zero, returns a zero-length #GBytes and does nothing. A value of
larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error. On success, a new #GBytes 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 #GBytes 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 @error is set accordingly.count is maximum number of bytes that will be read from the stream. Common values include 4096 and 8192..cancellable is optional #GCancellable object, %NULL to ignore..a new #GBytes, or %NULL on error.read_bytes_async (int count, int io_priority, object cancellable, user_data)
Request an asynchronous read of @count bytes from the stream into a new #GBytes. When the operation is finished @callback will be called. You can then call g_input_stream_read_bytes_finish() to get the result of the operation. During an async request no other sync and async calls are allowed on @stream, and will result in %G_IO_ERROR_PENDING errors. A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error. On success, the new #GBytes will be passed to the callback. It is not an error if this is smaller than the requested size, as it can happen e.g. near the end of a file, but generally we try to read as many bytes as requested. Zero is returned on end of file (or if @count is zero), but never otherwise. Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is %G_PRIORITY_DEFAULT.
count is the number of bytes that will be read from the stream.io_priority is the I/O priority of the request.cancellable is optional #GCancellable object, %NULL to ignore..callback is a #GAsyncReadyCallback to call when the request is satisfied.user_data is the data to pass to callback function.None.read_bytes_finish (object result)
Finishes an asynchronous stream read-into-#GBytes operation.
result is a #GAsyncResult..the newly-allocated #GBytes, or %NULL on error.read_finish (object result)
Finishes an asynchronous stream read operation.
result is a #GAsyncResult..number of bytes read in, or -1 on error, or 0 on end of file..set_pending ()
Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error.
%TRUE if pending was previously unset and is now set..skip (int count, object cancellable)
Tries to skip @count bytes from the stream. Will block during the operation. This is identical to g_input_stream_read(), from a behaviour standpoint, but the bytes that are skipped are not returned to the user. Some streams have an implementation that is more efficient than reading the data. This function is optional for inherited classes, as the default implementation emulates it using read. 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.
count is the number of bytes that will be skipped from the stream.cancellable is optional #GCancellable object, %NULL to ignore..Number of bytes skipped, or -1 on error.skip_async (int count, int io_priority, object cancellable, user_data)
Request an asynchronous skip of @count bytes from the stream. When the operation is finished @callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation. During an async request no other sync and async calls are allowed, and will result in %G_IO_ERROR_PENDING errors. A value of @count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error. On success, the number of bytes skipped will be passed to the callback. 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, but generally we try to skip as many bytes as requested. Zero is returned on end of file (or if @count is zero), but never otherwise. Any outstanding i/o request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is %G_PRIORITY_DEFAULT. The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one, you must override all.
count is the number of bytes that will be skipped from the stream.io_priority is the I/O priority of the request.cancellable is optional #GCancellable object, %NULL to ignore..callback is a #GAsyncReadyCallback to call when the request is satisfied.user_data is the data to pass to callback function.None.skip_finish (object result)
Finishes a stream skip operation.
result is a #GAsyncResult..the size of the bytes skipped, or -1 on error..
