Class (GI Class)

Gio-2.0GioDataOutputStream

Data output stream implements Gio.OutputStream and includes functions for writing data directly to an output stream.

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Accessors - Inherited from Gio.FilterOutputStream

Methods

Methods - Inherited from Gio.FilterOutputStream

Constructors

Properties

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

Accessors

Accessors - Inherited from Gio.FilterOutputStream

  • get close_base_stream(): boolean

    Whether the base stream should be closed when the filter stream is closed.

    Returns boolean

  • get closeBaseStream(): boolean

    Whether the base stream should be closed when the filter stream is closed.

    Returns boolean

Methods

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

    Parameters

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

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

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

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

    Parameters

    • ...args: never[]

      the property on source to bind

    Returns any

    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.

  • Tests if the length of the stream can be adjusted with g_seekable_truncate().

    Returns boolean

    true if the stream can be truncated, false otherwise.

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

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

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

    Returns void

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    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.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      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

    Returns any

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

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

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

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • 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]);
    

    Parameters

    Returns void

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

    Returns GObject.Object

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

    Returns GObject.Object

    object

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

    Parameters

    Returns boolean

    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.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

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

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • 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().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Tells the current position within the stream.

    Returns number

    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.

    Returns void

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

    Parameters

    Returns boolean

    true if successful. If an error has occurred, this function will return false and set error appropriately if present.

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

    Returns void

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

    Returns void

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

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    Returns boolean

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

    Parameters

    Returns void

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

    Parameters

    Returns boolean

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

    Parameters

    Returns void

Methods - Inherited from Gio.FilterOutputStream

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

    Closing a stream will automatically flush any outstanding buffers in the stream.

    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, otherwise there might be a loss of data as all data might not be written.

    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 there some streams can use a faster close that doesn't block to e.g. check errors. On cancellation (as with any error) there is no guarantee that all written data will reach the target.

    Parameters

    Returns boolean

    true on success, false on failure

  • Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation.

    For behaviour details see g_output_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.

    Parameters

    • io_priority: number

      the io priority of the request.

    • Optionalcancellable: Gio.Cancellable

      optional cancellable object

    Returns Promise<boolean>

  • Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation.

    For behaviour details see g_output_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.

    Parameters

    Returns void

  • Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation.

    For behaviour details see g_output_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.

    Parameters

    Returns void | Promise<boolean>

  • Forces a write of all user-space buffered data for the given stream. Will block during the operation. Closing the stream will implicitly cause a flush.

    This function is optional for inherited classes.

    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.

    Parameters

    Returns boolean

    true on success, false on error

  • Checks if an output stream is being closed. This can be used inside e.g. a flush implementation to see if the flush (or other i/o operation) is called from within the closing operation.

    Returns boolean

    true if stream is being closed. false otherwise.

  • Sets stream to have actions pending. If the pending flag is already set or stream is closed, it will return false and set error.

    Returns boolean

    true if pending was previously unset and is now set.

  • Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation.

    For behaviour details see g_output_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.

    Parameters

    Returns void

  • Forces a write of all user-space buffered data for the given stream. Will block during the operation. Closing the stream will implicitly cause a flush.

    This function is optional for inherited classes.

    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.

    Parameters

    Returns boolean

  • Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call g_output_stream_write_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 written 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. on a partial I/O error, but generally we try to write as many bytes as requested.

    You are guaranteed that this method will never fail with Gio.IOErrorEnum.WOULD_BLOCK - if stream can't accept more data, the method will just wait until this changes.

    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.

    For the synchronous, blocking version of this function, see g_output_stream_write().

    Note that no copy of buffer will be made, so it must stay valid until callback is called. See g_output_stream_write_bytes_async() for a GLib.Bytes version that will automatically hold a reference to the contents (without copying) for the duration of the call.

    Parameters

    Returns void

  • Tries to write count bytes from buffer into the stream. Will block during the operation.

    If count is 0, returns 0 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 written to the stream is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial I/O error, or if there is not enough storage in the stream. All writes block until at least one byte is written or an error occurs; 0 is never returned (unless count is 0).

    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.

    Parameters

    • Optionalbuffer: Uint8Array<ArrayBufferLike>

      the buffer containing the data to write.

    • Optionalcancellable: Gio.Cancellable

      optional cancellable object

    Returns number

  • Request an asynchronous write of the bytes contained in n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call g_output_stream_writev_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.

    On success, the number of bytes written 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. on a partial I/O error, but generally we try to write as many bytes as requested.

    You are guaranteed that this method will never fail with Gio.IOErrorEnum.WOULD_BLOCK — if stream can't accept more data, the method will just wait until this changes.

    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.

    For the synchronous, blocking version of this function, see g_output_stream_writev().

    Note that no copy of vectors will be made, so it must stay valid until callback is called.

    Parameters

    Returns void

  • Tries to write the bytes contained in the n_vectors vectors into the stream. Will block during the operation.

    If n_vectors is 0 or the sum of all bytes in vectors is 0, returns 0 and does nothing.

    On success, the number of bytes written to the stream is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial I/O error, or if there is not enough storage in the stream. All writes block until at least one byte is written or an error occurs; 0 is never returned (unless n_vectors is 0 or the sum of all bytes in vectors is 0).

    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.

    Some implementations of g_output_stream_writev() may have limitations on the aggregate buffer size, and will return Gio.IOErrorEnum.INVALID_ARGUMENT if these are exceeded. For example, when writing to a local file on UNIX platforms, the aggregate buffer size must not exceed G_MAXSSIZE bytes.

    Parameters

    • vectors: OutputVector[]

      the buffer containing the GOutputVectors to write.

    • Optionalcancellable: Gio.Cancellable

      optional cancellable object

    Returns [boolean, number]

  • Tries to write count bytes from buffer into the stream. Will block during the operation.

    If count is 0, returns 0 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 written to the stream is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial I/O error, or if there is not enough storage in the stream. All writes block until at least one byte is written or an error occurs; 0 is never returned (unless count is 0).

    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.

    Parameters

    • buffer: string | Uint8Array<ArrayBufferLike>

      the buffer containing the data to write.

    • Optionalcancellable: Gio.Cancellable

      optional cancellable object

    Returns number

    Number of bytes written, or -1 on error

  • Tries to write count bytes from buffer into the stream. Will block during the operation.

    This function is similar to g_output_stream_write(), except it tries to write as many bytes as requested, only stopping on an error.

    On a successful write of count bytes, true is returned, and bytes_written is set to count.

    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_written will be set to the number of bytes that were successfully written 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_output_stream_write().

    Parameters

    • buffer: string | Uint8Array<ArrayBufferLike>

      the buffer containing the data to write.

    • Optionalcancellable: Gio.Cancellable

      optional Gio.Cancellable object, null to ignore.

    Returns [boolean, number]

    true on success, false if there was an error

  • Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call g_output_stream_write_all_finish() to get the result of the operation.

    This is the asynchronous version of g_output_stream_write_all().

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

    Note that no copy of buffer will be made, so it must stay valid until callback is called.

    Parameters

    • buffer: string | Uint8Array<ArrayBufferLike>

      the buffer containing the data to write

    • io_priority: number

      the io priority of the request

    • Optionalcancellable: Gio.Cancellable

      optional Gio.Cancellable object, null to ignore

    Returns Promise<number>

  • Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call g_output_stream_write_all_finish() to get the result of the operation.

    This is the asynchronous version of g_output_stream_write_all().

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

    Note that no copy of buffer will be made, so it must stay valid until callback is called.

    Parameters

    Returns void

  • Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call g_output_stream_write_all_finish() to get the result of the operation.

    This is the asynchronous version of g_output_stream_write_all().

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

    Note that no copy of buffer will be made, so it must stay valid until callback is called.

    Parameters

    Returns void | Promise<number>

  • Finishes an asynchronous stream write operation started with g_output_stream_write_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_written will be set to the number of bytes that were successfully written 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_output_stream_write_async().

    Parameters

    Returns [boolean, number]

    true on success, false if there was an error

  • Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call g_output_stream_write_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 written 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. on a partial I/O error, but generally we try to write as many bytes as requested.

    You are guaranteed that this method will never fail with Gio.IOErrorEnum.WOULD_BLOCK - if stream can't accept more data, the method will just wait until this changes.

    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.

    For the synchronous, blocking version of this function, see g_output_stream_write().

    Note that no copy of buffer will be made, so it must stay valid until callback is called. See g_output_stream_write_bytes_async() for a GLib.Bytes version that will automatically hold a reference to the contents (without copying) for the duration of the call.

    Parameters

    • buffer: string | Uint8Array<ArrayBufferLike>

      the buffer containing the data to write.

    • io_priority: number

      the io priority of the request.

    • Optionalcancellable: Gio.Cancellable

      optional Gio.Cancellable object, null to ignore.

    Returns Promise<number>

  • Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call g_output_stream_write_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 written 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. on a partial I/O error, but generally we try to write as many bytes as requested.

    You are guaranteed that this method will never fail with Gio.IOErrorEnum.WOULD_BLOCK - if stream can't accept more data, the method will just wait until this changes.

    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.

    For the synchronous, blocking version of this function, see g_output_stream_write().

    Note that no copy of buffer will be made, so it must stay valid until callback is called. See g_output_stream_write_bytes_async() for a GLib.Bytes version that will automatically hold a reference to the contents (without copying) for the duration of the call.

    Parameters

    Returns void

  • Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call g_output_stream_write_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 written 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. on a partial I/O error, but generally we try to write as many bytes as requested.

    You are guaranteed that this method will never fail with Gio.IOErrorEnum.WOULD_BLOCK - if stream can't accept more data, the method will just wait until this changes.

    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.

    For the synchronous, blocking version of this function, see g_output_stream_write().

    Note that no copy of buffer will be made, so it must stay valid until callback is called. See g_output_stream_write_bytes_async() for a GLib.Bytes version that will automatically hold a reference to the contents (without copying) for the duration of the call.

    Parameters

    Returns void | Promise<number>

  • A wrapper function for g_output_stream_write() which takes a GLib.Bytes as input. This can be more convenient for use by language bindings or in other cases where the refcounted nature of GLib.Bytes is helpful over a bare pointer interface.

    However, note that this function may still perform partial writes, just like g_output_stream_write(). If that occurs, to continue writing, you will need to create a new GLib.Bytes containing just the remaining bytes, using g_bytes_new_from_bytes(). Passing the same GLib.Bytes instance multiple times potentially can result in duplicated data in the output stream.

    Parameters

    Returns number

    Number of bytes written, or -1 on error

  • This function is similar to g_output_stream_write_async(), but takes a GLib.Bytes as input. Due to the refcounted nature of GLib.Bytes, this allows the stream to avoid taking a copy of the data.

    However, note that this function may still perform partial writes, just like g_output_stream_write_async(). If that occurs, to continue writing, you will need to create a new GLib.Bytes containing just the remaining bytes, using g_bytes_new_from_bytes(). Passing the same GLib.Bytes instance multiple times potentially can result in duplicated data in the output stream.

    For the synchronous, blocking version of this function, see g_output_stream_write_bytes().

    Parameters

    • bytes: Uint8Array<ArrayBufferLike> | GLib.Bytes

      The bytes to write

    • io_priority: number

      the io priority of the request.

    • Optionalcancellable: Gio.Cancellable

      optional Gio.Cancellable object, null to ignore.

    Returns Promise<number>

  • This function is similar to g_output_stream_write_async(), but takes a GLib.Bytes as input. Due to the refcounted nature of GLib.Bytes, this allows the stream to avoid taking a copy of the data.

    However, note that this function may still perform partial writes, just like g_output_stream_write_async(). If that occurs, to continue writing, you will need to create a new GLib.Bytes containing just the remaining bytes, using g_bytes_new_from_bytes(). Passing the same GLib.Bytes instance multiple times potentially can result in duplicated data in the output stream.

    For the synchronous, blocking version of this function, see g_output_stream_write_bytes().

    Parameters

    Returns void

  • This function is similar to g_output_stream_write_async(), but takes a GLib.Bytes as input. Due to the refcounted nature of GLib.Bytes, this allows the stream to avoid taking a copy of the data.

    However, note that this function may still perform partial writes, just like g_output_stream_write_async(). If that occurs, to continue writing, you will need to create a new GLib.Bytes containing just the remaining bytes, using g_bytes_new_from_bytes(). Passing the same GLib.Bytes instance multiple times potentially can result in duplicated data in the output stream.

    For the synchronous, blocking version of this function, see g_output_stream_write_bytes().

    Parameters

    Returns void | Promise<number>

  • Tries to write the bytes contained in the n_vectors vectors into the stream. Will block during the operation.

    If n_vectors is 0 or the sum of all bytes in vectors is 0, returns 0 and does nothing.

    On success, the number of bytes written to the stream is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. on a partial I/O error, or if there is not enough storage in the stream. All writes block until at least one byte is written or an error occurs; 0 is never returned (unless n_vectors is 0 or the sum of all bytes in vectors is 0).

    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.

    Some implementations of g_output_stream_writev() may have limitations on the aggregate buffer size, and will return Gio.IOErrorEnum.INVALID_ARGUMENT if these are exceeded. For example, when writing to a local file on UNIX platforms, the aggregate buffer size must not exceed G_MAXSSIZE bytes.

    Parameters

    • vectors: OutputVector[]

      the buffer containing the GOutputVectors to write.

    • Optionalcancellable: Gio.Cancellable

      optional cancellable object

    Returns [boolean, number]

    true on success, false if there was an error

  • Tries to write the bytes contained in the n_vectors vectors into the stream. Will block during the operation.

    This function is similar to g_output_stream_writev(), except it tries to write as many bytes as requested, only stopping on an error.

    On a successful write of all n_vectors vectors, true is returned, and bytes_written is set to the sum of all the sizes of vectors.

    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_written will be set to the number of bytes that were successfully written 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_output_stream_write().

    The content of the individual elements of vectors might be changed by this function.

    Parameters

    Returns [boolean, number]

    true on success, false if there was an error

  • Request an asynchronous write of the bytes contained in the n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call g_output_stream_writev_all_finish() to get the result of the operation.

    This is the asynchronous version of g_output_stream_writev_all().

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

    Note that no copy of vectors will be made, so it must stay valid until callback is called. The content of the individual elements of vectors might be changed by this function.

    Parameters

    • vectors: OutputVector[]

      the buffer containing the GOutputVectors to write.

    • io_priority: number

      the I/O priority of the request

    • Optionalcancellable: Gio.Cancellable

      optional Gio.Cancellable object, null to ignore

    Returns Promise<number>

  • Request an asynchronous write of the bytes contained in the n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call g_output_stream_writev_all_finish() to get the result of the operation.

    This is the asynchronous version of g_output_stream_writev_all().

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

    Note that no copy of vectors will be made, so it must stay valid until callback is called. The content of the individual elements of vectors might be changed by this function.

    Parameters

    Returns void

  • Request an asynchronous write of the bytes contained in the n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call g_output_stream_writev_all_finish() to get the result of the operation.

    This is the asynchronous version of g_output_stream_writev_all().

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

    Note that no copy of vectors will be made, so it must stay valid until callback is called. The content of the individual elements of vectors might be changed by this function.

    Parameters

    Returns void | Promise<number>

  • Finishes an asynchronous stream write operation started with g_output_stream_writev_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_written will be set to the number of bytes that were successfully written 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_output_stream_writev_async().

    Parameters

    Returns [boolean, number]

    true on success, false if there was an error

  • Request an asynchronous write of the bytes contained in n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call g_output_stream_writev_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.

    On success, the number of bytes written 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. on a partial I/O error, but generally we try to write as many bytes as requested.

    You are guaranteed that this method will never fail with Gio.IOErrorEnum.WOULD_BLOCK — if stream can't accept more data, the method will just wait until this changes.

    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.

    For the synchronous, blocking version of this function, see g_output_stream_writev().

    Note that no copy of vectors will be made, so it must stay valid until callback is called.

    Parameters

    • vectors: OutputVector[]

      the buffer containing the GOutputVectors to write.

    • io_priority: number

      the I/O priority of the request.

    • Optionalcancellable: Gio.Cancellable

      optional Gio.Cancellable object, null to ignore.

    Returns Promise<number>

  • Request an asynchronous write of the bytes contained in n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call g_output_stream_writev_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.

    On success, the number of bytes written 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. on a partial I/O error, but generally we try to write as many bytes as requested.

    You are guaranteed that this method will never fail with Gio.IOErrorEnum.WOULD_BLOCK — if stream can't accept more data, the method will just wait until this changes.

    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.

    For the synchronous, blocking version of this function, see g_output_stream_writev().

    Note that no copy of vectors will be made, so it must stay valid until callback is called.

    Parameters

    Returns void

  • Request an asynchronous write of the bytes contained in n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call g_output_stream_writev_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.

    On success, the number of bytes written 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. on a partial I/O error, but generally we try to write as many bytes as requested.

    You are guaranteed that this method will never fail with Gio.IOErrorEnum.WOULD_BLOCK — if stream can't accept more data, the method will just wait until this changes.

    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.

    For the synchronous, blocking version of this function, see g_output_stream_writev().

    Note that no copy of vectors will be made, so it must stay valid until callback is called.

    Parameters

    Returns void | Promise<number>

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

    Parameters

    Returns void

Interfaces

ConstructorProps
SignalSignatures