Optionalproperties: Partial<Gio.MemoryInputStream.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeAppends data to data that can be read from the input stream
input data
Optionaldestroy: DestroyNotifyfunction that is called to free data, or null
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Checks if stream is actually pollable. Some classes may implement
Gio.PollableInputStream but have only certain instances of that class
be pollable. If this method returns false, then the behavior of
other Gio.PollableInputStream methods is undefined.
For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa.
true if stream is pollable, false if not.
Tests if the stream supports the Gio.SeekableIface.
true if seekable can be seeked. false otherwise.
Tests if the length of the stream can be adjusted with
g_seekable_truncate().
true if the stream can be truncated, false otherwise.
Clears the pending flag on stream.
Closes the stream, releasing resources related to it.
Once the stream is closed, all other operations will return Gio.IOErrorEnum.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 Gio.IOErrorEnum.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 Gio.IOErrorEnum.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.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
true on success, false on failure
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.
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional cancellable object
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.
the I/O priority of the request
optional cancellable object
a Gio.AsyncReadyCallback to call when the request is satisfied
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.
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional cancellable object
Optionalcallback: AsyncReadyCallback<Gio.MemoryInputStream>a Gio.AsyncReadyCallback to call when the request is satisfied
Finishes closing a stream asynchronously, started from g_input_stream_close_async().
true if the stream was closed successfully.
SignalconnectSignalconnect_Creates a GLib.Source that triggers when stream can be read, or
cancellable is triggered or an error occurs. The callback on the
source is of the Gio.PollableSourceFunc type.
As with g_pollable_input_stream_is_readable(), it is possible that
the stream may not actually be readable even after the source
triggers, so you should use g_pollable_input_stream_read_nonblocking()
rather than g_input_stream_read() from the callback.
The behaviour of this method is undefined if
g_pollable_input_stream_can_poll() returns false for stream.
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
a new GLib.Source
Creates an asynchronous iterator for a Gio.InputStream that reads the stream in chunks.
Each iteration will return a GLib.Bytes object containing at most count bytes (default 4096). The iterator will end when the stream is exhausted.
Example:
import Gio from "gi://Gio";
const textDecoder = new TextDecoder("utf-8");
const file = Gio.File.new_for_path("/etc/os-release");
const inputStream = file.read(null);
for await (const bytes of inputStream.createAsyncIterator(4)) {
log(textDecoder.decode(bytes.toArray()));
}
returns An async iterator yielding GLib.Bytes objects
Optionalcount: numberMaximum number of bytes to read per chunk (default: 4096)
Optionalpriority: numberI/O priority of the request (default: GLib.PRIORITY_DEFAULT)
Creates a synchronous iterator for a Gio.InputStream that reads the stream in chunks.
Each iteration will return a GLib.Bytes object containing at most count bytes (default 4096). The iterator will end when the stream is exhausted.
Example:
import Gio from "gi://Gio";
const textDecoder = new TextDecoder("utf-8");
const file = Gio.File.new_for_path("/etc/os-release");
const inputStream = file.read(null);
for (const bytes of inputStream.createSyncIterator(4)) {
log(textDecoder.decode(bytes.toArray()));
}
returns An iterable yielding GLib.Bytes objects
Optionalcount: numberMaximum number of bytes to read per chunk (default: 4096)
Optionalpriority: numberI/O priority of the request (default: GLib.PRIORITY_DEFAULT)
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
SignalemitThis function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks if an input stream has pending actions.
true if stream has pending actions.
Checks if an input stream is closed.
true if the stream is closed.
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Checks if stream can be read.
Note that some stream types may not be able to implement this 100%
reliably, and it is possible that a call to g_input_stream_read()
after this returns true would still block. To guarantee
non-blocking behavior, you should always use
g_pollable_input_stream_read_nonblocking(), which will return a
Gio.IOErrorEnum.WOULD_BLOCK error rather than blocking.
The behaviour of this method is undefined if
g_pollable_input_stream_can_poll() returns false for stream.
true if stream is readable, false if not. If an error has occurred on stream, this will result in g_pollable_input_stream_is_readable() returning true, and the next attempt to read will return the error.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
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.
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.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.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Number of bytes read, or -1 on error, or 0 on end of file.
Tries to read count bytes from the stream into the buffer starting at
buffer. 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 into buffer.
If there is an error during the operation false is returned and error
is set to indicate the error status.
As a special exception to the normal conventions for functions that
use GLib.Error, 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().
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
true on success, false if there was an error
Request an asynchronous read of count bytes from the stream into the
buffer starting at buffer.
This is the asynchronous equivalent of InputStream.read_all.
Call 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.
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Request an asynchronous read of count bytes from the stream into the
buffer starting at buffer.
This is the asynchronous equivalent of InputStream.read_all.
Call 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.
the I/O priority of the request
optional Gio.Cancellable object, null to ignore
a Gio.AsyncReadyCallback to call when the request is satisfied
Request an asynchronous read of count bytes from the stream into the
buffer starting at buffer.
This is the asynchronous equivalent of InputStream.read_all.
Call 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.
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore
Optionalcallback: AsyncReadyCallback<Gio.MemoryInputStream>a Gio.AsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous stream read operation started with InputStream.read_all_async.
As a special exception to the normal conventions for functions that
use GLib.Error, 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().
true on success, false if there was an error
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 Gio.IOErrorEnum.PENDING errors.
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 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.
the I/O priority of the request.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
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 Gio.IOErrorEnum.PENDING errors.
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 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.
the I/O priority of the request.
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback to call when the request is satisfied
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 Gio.IOErrorEnum.PENDING errors.
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 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.
the I/O priority of the request.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.MemoryInputStream>a Gio.AsyncReadyCallback to call when the request is satisfied
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 GLib.Bytes containing
the data that was read. This may be easier to use from language
bindings.
If count is zero, returns a zero-length GLib.Bytes and does nothing. A
value of count larger than G_MAXSSIZE will cause a
Gio.IOErrorEnum.INVALID_ARGUMENT error.
On success, a new GLib.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 GLib.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 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 null is returned and error is set accordingly.
maximum number of bytes that will be read from the stream. Common values include 4096 and 8192.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
a new GLib.Bytes, or null on error
Request an asynchronous read of count bytes from the stream into a
new GLib.Bytes. 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 Gio.IOErrorEnum.PENDING errors.
A value of count larger than G_MAXSSIZE will cause a
Gio.IOErrorEnum.INVALID_ARGUMENT error.
On success, the new GLib.Bytes 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.
the number of bytes that will be read from the stream
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Request an asynchronous read of count bytes from the stream into a
new GLib.Bytes. 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 Gio.IOErrorEnum.PENDING errors.
A value of count larger than G_MAXSSIZE will cause a
Gio.IOErrorEnum.INVALID_ARGUMENT error.
On success, the new GLib.Bytes 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.
the number of bytes that will be read from the stream
the I/O priority of the request
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback to call when the request is satisfied
Request an asynchronous read of count bytes from the stream into a
new GLib.Bytes. 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 Gio.IOErrorEnum.PENDING errors.
A value of count larger than G_MAXSSIZE will cause a
Gio.IOErrorEnum.INVALID_ARGUMENT error.
On success, the new GLib.Bytes 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.
the number of bytes that will be read from the stream
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.MemoryInputStream>a Gio.AsyncReadyCallback to call when the request is satisfied
Finishes an asynchronous stream read-into-GLib.Bytes operation.
the newly-allocated GLib.Bytes, or null on error
Finishes an asynchronous stream read operation.
number of bytes read in, or -1 on error, or 0 on end of file.
Attempts to read up to count bytes from stream into buffer, as
with g_input_stream_read(). If stream is not currently readable,
this will immediately return Gio.IOErrorEnum.WOULD_BLOCK, and you can
use g_pollable_input_stream_create_source() to create a GLib.Source
that will be triggered when stream is readable.
Note that since this method never blocks, you cannot actually
use cancellable to cancel it. However, it will return an error
if cancellable has already been cancelled when you call, which
may happen if you call this method after a source triggers due
to having been cancelled.
The behaviour of this method is undefined if
g_pollable_input_stream_can_poll() returns false for stream.
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
the number of bytes read, or -1 on error (including Gio.IOErrorEnum.WOULD_BLOCK).
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Seeks in the stream by the given offset, modified by type.
Attempting to seek past the end of the stream will have different results depending on if the stream is fixed-sized or resizable. If the stream is resizable then seeking past the end and then writing will result in zeros filling the empty space. Seeking past the end of a resizable stream and reading will result in EOF. Seeking past the end of a fixed-sized stream will fail.
Any operation that would result in a negative offset will fail.
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.
a goffset.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
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.
Sets a property on an object.
The name of the property to set
The value to set the property to
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 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.
the number of bytes that will be skipped from the stream
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Number of bytes skipped, or -1 on error
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 Gio.IOErrorEnum.PENDING errors.
A value of count larger than G_MAXSSIZE will cause a Gio.IOErrorEnum.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.
the number of bytes that will be skipped from the stream
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
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 Gio.IOErrorEnum.PENDING errors.
A value of count larger than G_MAXSSIZE will cause a Gio.IOErrorEnum.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.
the number of bytes that will be skipped from the stream
the I/O priority of the request
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback to call when the request is satisfied
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 Gio.IOErrorEnum.PENDING errors.
A value of count larger than G_MAXSSIZE will cause a Gio.IOErrorEnum.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.
the number of bytes that will be skipped from the stream
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.MemoryInputStream>a Gio.AsyncReadyCallback to call when the request is satisfied
Finishes a stream skip operation.
the size of the bytes skipped, or -1 on error.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Tells the current position within the stream.
the (positive or zero) offset from the beginning of the buffer, zero if the target is not seekable.
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Sets the length of the stream to offset. If the stream was previously
larger than offset, the extra data is discarded. If the stream was
previously shorter than offset, it is extended with NUL ('\0') bytes.
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.
new length for seekable, in bytes.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_Checks if stream is actually pollable. Some classes may implement
Gio.PollableInputStream but have only certain instances of that class
be pollable. If this method returns false, then the behavior of
other Gio.PollableInputStream methods is undefined.
For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa.
Virtualvfunc_Tests if the stream supports the Gio.SeekableIface.
Virtualvfunc_Tests if the length of the stream can be adjusted with
g_seekable_truncate().
Virtualvfunc_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.
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional cancellable object
Optionalcallback: AsyncReadyCallback<Gio.MemoryInputStream>a Gio.AsyncReadyCallback to call when the request is satisfied
Virtualvfunc_Finishes closing a stream asynchronously, started from g_input_stream_close_async().
Virtualvfunc_Optionalcancellable: Gio.CancellableVirtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Creates a GLib.Source that triggers when stream can be read, or
cancellable is triggered or an error occurs. The callback on the
source is of the Gio.PollableSourceFunc type.
As with g_pollable_input_stream_is_readable(), it is possible that
the stream may not actually be readable even after the source
triggers, so you should use g_pollable_input_stream_read_nonblocking()
rather than g_input_stream_read() from the callback.
The behaviour of this method is undefined if
g_pollable_input_stream_can_poll() returns false for stream.
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Checks if stream can be read.
Note that some stream types may not be able to implement this 100%
reliably, and it is possible that a call to g_input_stream_read()
after this returns true would still block. To guarantee
non-blocking behavior, you should always use
g_pollable_input_stream_read_nonblocking(), which will return a
Gio.IOErrorEnum.WOULD_BLOCK error rather than blocking.
The behaviour of this method is undefined if
g_pollable_input_stream_can_poll() returns false for stream.
Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_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 Gio.IOErrorEnum.PENDING errors.
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 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.
the I/O priority of the request.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.MemoryInputStream>a Gio.AsyncReadyCallback to call when the request is satisfied
Virtualvfunc_Virtualvfunc_Optionalcancellable: Gio.CancellableVirtualvfunc_Attempts to read up to count bytes from stream into buffer, as
with g_input_stream_read(). If stream is not currently readable,
this will immediately return Gio.IOErrorEnum.WOULD_BLOCK, and you can
use g_pollable_input_stream_create_source() to create a GLib.Source
that will be triggered when stream is readable.
Note that since this method never blocks, you cannot actually
use cancellable to cancel it. However, it will return an error
if cancellable has already been cancelled when you call, which
may happen if you call this method after a source triggers due
to having been cancelled.
The behaviour of this method is undefined if
g_pollable_input_stream_can_poll() returns false for stream.
Virtualvfunc_Seeks in the stream by the given offset, modified by type.
Attempting to seek past the end of the stream will have different results depending on if the stream is fixed-sized or resizable. If the stream is resizable then seeking past the end and then writing will result in zeros filling the empty space. Seeking past the end of a resizable stream and reading will result in EOF. Seeking past the end of a fixed-sized stream will fail.
Any operation that would result in a negative offset will fail.
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.
a goffset.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
Virtualvfunc_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 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.
the number of bytes that will be skipped from the stream
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Virtualvfunc_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 Gio.IOErrorEnum.PENDING errors.
A value of count larger than G_MAXSSIZE will cause a Gio.IOErrorEnum.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.
the number of bytes that will be skipped from the stream
the I/O priority of the request
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gio.MemoryInputStream>a Gio.AsyncReadyCallback to call when the request is satisfied
Virtualvfunc_Virtualvfunc_Tells the current position within the stream.
Virtualvfunc_Sets the length of the stream to offset. If the stream was previously
larger than offset, the extra data is discarded. If the stream was
previously shorter than offset, it is extended with NUL ('\0') bytes.
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.
new length for seekable, in bytes.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
StaticnewStaticnew_Staticnew_Optionaldestroy: DestroyNotifyStatic_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Gio.MemoryInputStream is a class for using arbitrary memory chunks as input for GIO streaming input operations.
As of GLib 2.34, Gio.MemoryInputStream implements Gio.PollableInputStream.