Gjsify LogoGjsify Logo

Buffered output stream implements #GFilterOutputStream and provides for buffered writes.

By default, #GBufferedOutputStream's buffer size is set at 4 kilobytes.

To create a buffered output stream, use g_buffered_output_stream_new(), or g_buffered_output_stream_new_sized() to specify the buffer's size at construction.

To get the size of a buffer within a buffered input stream, use g_buffered_output_stream_get_buffer_size(). To change the size of a buffered output stream's buffer, use g_buffered_output_stream_set_buffer_size(). Note that the buffer's size cannot be reduced below the size of the data within the buffer.

Hierarchy

Index

Constructors

Properties

auto_grow: boolean
base_stream: Gio.OutputStream
buffer_size: number
close_base_stream: boolean
g_type_instance: TypeInstance
parent_instance: Gio.FilterOutputStream
name: string

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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • can_seek(): boolean
  • can_truncate(): boolean
  • clear_pending(): void
  • Closes the stream, releasing resources related to it.

    Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error.

    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 %G_IO_ERROR_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 %G_IO_ERROR_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

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

    • cancellable: Gio.Cancellable

      optional cancellable object

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    Returns void

  • connect_after(sigName: "notify::auto-grow", callback: (($obj: BufferedOutputStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::buffer-size", callback: (($obj: BufferedOutputStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::close-base-stream", callback: (($obj: BufferedOutputStream, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): void
  • emit(sigName: "notify::auto-grow", ...args: any[]): void
  • emit(sigName: "notify::buffer-size", ...args: any[]): void
  • emit(sigName: "notify::close-base-stream", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): 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 %G_IO_ERROR_CANCELLED will be returned.

    Parameters

    Returns boolean

  • Forces an asynchronous write of all user-space buffered data for the given stream. For behaviour details see g_output_stream_flush().

    When the operation is finished callback will be called. You can then call g_output_stream_flush_finish() to get the result of the operation.

    Parameters

    • io_priority: number

      the io priority of the request.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • force_floating(): void
  • This function is intended for #GObject 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().

    Returns void

  • freeze_notify(): 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::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

  • get_auto_grow(): boolean
  • get_buffer_size(): number
  • get_close_base_stream(): boolean
  • get_data(key?: string): object
  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue 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 g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • getv(names: string[], values: any[]): void
  • 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

  • has_pending(): boolean
  • is_closed(): boolean
  • is_closing(): boolean
  • 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

  • is_floating(): boolean
  • notify(property_name: string): 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    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

  • 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

  • run_dispose(): 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 %G_IO_ERROR_CANCELLED will be returned.

    Parameters

    • offset: number

      a #goffset.

    • type: GLib.SeekType

      a #GSeekType.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • set_auto_grow(auto_grow: boolean): void
  • Sets whether or not the stream's buffer should automatically grow. If auto_grow is true, then each write will just make the buffer larger, and you must manually flush the buffer to actually write out the data to the underlying stream.

    Parameters

    • auto_grow: boolean

      a #gboolean.

    Returns void

  • set_buffer_size(size: number): void
  • set_close_base_stream(close_base: boolean): void
  • set_data(key: string, data?: object): 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_pending(): boolean
  • set_property(property_name: string, value?: any): void
  • Splices a stream asynchronously. When the operation is finished callback will be called. You can then call g_output_stream_splice_finish() to get the result of the operation.

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

    Parameters

    Returns void

  • steal_data(key?: string): object
  • steal_qdata(quark: number): object
  • 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 #GQuark, naming the user data pointer

    Returns object

  • tell(): number
  • thaw_notify(): void
  • 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::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 %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

    Parameters

    • offset: number

      new length for seekable, in bytes.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • unref(): void
  • 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 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 instance. Use g_clear_object() for this.

    Returns void

  • vfunc_can_seek(): boolean
  • vfunc_can_truncate(): 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.

    virtual

    Parameters

    • io_priority: number

      the io priority of the request.

    • cancellable: Gio.Cancellable

      optional cancellable object

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): 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 %G_IO_ERROR_CANCELLED will be returned.

    virtual

    Parameters

    Returns boolean

  • Forces an asynchronous write of all user-space buffered data for the given stream. For behaviour details see g_output_stream_flush().

    When the operation is finished callback will be called. You can then call g_output_stream_flush_finish() to get the result of the operation.

    virtual

    Parameters

    • io_priority: number

      the io priority of the request.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): 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.

    virtual

    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 %G_IO_ERROR_CANCELLED will be returned.

    virtual

    Parameters

    • offset: number

      a #goffset.

    • type: GLib.SeekType

      a #GSeekType.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • Splices a stream asynchronously. When the operation is finished callback will be called. You can then call g_output_stream_splice_finish() to get the result of the operation.

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

    virtual

    Parameters

    Returns void

  • vfunc_tell(): number
  • vfunc_truncate_fn(offset: number, cancellable: Gio.Cancellable): boolean
  • 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 %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

    virtual

    Parameters

    • offset: number

      new length for seekable, in bytes.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    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 %G_IO_ERROR_PENDING errors.

    A value of count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.

    On success, the number of bytes 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 %G_IO_ERROR_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 #GBytes version that will automatically hold a reference to the contents (without copying) for the duration of the call.

    virtual

    Parameters

    • buffer: Uint8Array

      the buffer containing the data to write.

    • io_priority: number

      the io priority of the request.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    Returns void

  • vfunc_write_fn(buffer: Uint8Array, cancellable: Gio.Cancellable): 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 %G_IO_ERROR_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 %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

    On error -1 is returned and error is set accordingly.

    virtual

    Parameters

    • buffer: Uint8Array

      the buffer containing the data to write.

    • cancellable: 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 %G_IO_ERROR_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 %G_IO_ERROR_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.

    virtual

    Parameters

    • vectors: OutputVector[]

      the buffer containing the #GOutputVectors to write.

    • io_priority: number

      the I/O priority of the request.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    Returns void

  • vfunc_writev_finish(result: AsyncResult): [boolean, 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 %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

    Some implementations of g_output_stream_writev() may have limitations on the aggregate buffer size, and will return %G_IO_ERROR_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.

    virtual

    Parameters

    • vectors: OutputVector[]

      the buffer containing the #GOutputVectors to write.

    • cancellable: Gio.Cancellable

      optional cancellable object

    Returns [boolean, number]

  • watch_closure(closure: TClosure<any, any>): void
  • 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

    • closure: TClosure<any, any>

      #GClosure to watch

    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 %G_IO_ERROR_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 %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

    On error -1 is returned and error is set accordingly.

    Parameters

    • buffer: Uint8Array

      the buffer containing the data to write.

    • cancellable: Gio.Cancellable

      optional cancellable object

    Returns number

  • write_all(buffer: Uint8Array, cancellable: Gio.Cancellable): [boolean, number]
  • 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 #GError, 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: Uint8Array

      the buffer containing the data to write.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns [boolean, 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

    • buffer: Uint8Array

      the buffer containing the data to write

    • io_priority: number

      the io priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    Returns void

  • write_all_finish(result: AsyncResult): [boolean, 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 #GError, 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]

  • 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 %G_IO_ERROR_PENDING errors.

    A value of count larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.

    On success, the number of bytes 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 %G_IO_ERROR_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 #GBytes version that will automatically hold a reference to the contents (without copying) for the duration of the call.

    Parameters

    • buffer: Uint8Array

      the buffer containing the data to write.

    • io_priority: number

      the io priority of the request.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    Returns void

  • A wrapper function for g_output_stream_write() which takes a #GBytes as input. This can be more convenient for use by language bindings or in other cases where the refcounted nature of #GBytes 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 #GBytes containing just the remaining bytes, using g_bytes_new_from_bytes(). Passing the same #GBytes instance multiple times potentially can result in duplicated data in the output stream.

    Parameters

    Returns number

  • This function is similar to g_output_stream_write_async(), but takes a #GBytes as input. Due to the refcounted nature of #GBytes, 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 #GBytes containing just the remaining bytes, using g_bytes_new_from_bytes(). Passing the same #GBytes 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: Bytes

      The bytes to write

    • io_priority: number

      the io priority of the request.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    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 %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

    Some implementations of g_output_stream_writev() may have limitations on the aggregate buffer size, and will return %G_IO_ERROR_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.

    • cancellable: Gio.Cancellable

      optional cancellable object

    Returns [boolean, number]

  • 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 #GError, 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

    • vectors: OutputVector[]

      the buffer containing the #GOutputVectors to write.

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns [boolean, 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

    • vectors: OutputVector[]

      the buffer containing the #GOutputVectors to write.

    • io_priority: number

      the I/O priority of the request

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    Returns void

  • writev_all_finish(result: AsyncResult): [boolean, 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 #GError, 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]

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

    • cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • callback: AsyncReadyCallback

      callback to call when the request is satisfied

    Returns void

  • compat_control(what: number, data: object): number
  • Find the #GParamSpec 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().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • 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 #GParamSpec, 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 #GTypeInfo.) 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

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method