Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: BufferedOutputStreamCtors

[209:14] static extends: object

Alternate constructors for BufferedOutputStream. Usage: BufferedOutputStreamCtors.<name>(...). The primary constructor lives directly on BufferedOutputStream.

Methods

  • newSized (object base_stream, int size)

    Creates a new buffered output stream with a given buffer size.

    • @p base_stream is a [class@Gio.OutputStream]..
    • @p size is a #gsize..
    • @r A new BufferedOutputStream.

class: BufferedOutputStreamMeta

[227:14] static extends: object

Generated metadata helpers for BufferedOutputStream class surfaces.

Methods

  • properties ()

    Returns property metadata for BufferedOutputStream.

    • @r A list.

class: BufferedOutputStream

[21:7] extends: object

Buffered output stream implements [class@Gio.FilterOutputStream] and provides for buffered writes. By default, GBufferedOutputStream's buffer size is set at 4 kilobytes. To create a buffered output stream, use [ctor@Gio.BufferedOutputStream.new], or [ctor@Gio.BufferedOutputStream.new_sized] to specify the buffer's size at construction. To get the size of a buffer within a buffered input stream, use [method@Gio.BufferedOutputStream.get_buffer_size]. To change the size of a buffered output stream's buffer, use [method@Gio.BufferedOutputStream.set_buffer_size]. Note that the buffer's size cannot be reduced below the size of the data within the buffer.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • BufferedOutputStream (base_stream = null)

    Creates a new buffered output stream for a base stream.

    • @p base_stream is a [class@Gio.OutputStream]..
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asFilterOutputStream ()

    Wraps this handle as FilterOutputStream.

    • @r A FilterOutputStream object.
  • asSeekable ()

    Wraps this handle as Seekable.

    • @r A Seekable object.
  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setAutogrow (bool Value)

    Whether the buffer should automatically grow.

    • @p Value is the new property value.
    • @r None.
  • setBuffersize (int Value)

    The size of the backend buffer, in bytes.

    • @p Value is the new property value.
    • @r None.
  • get_auto_grow ()

    Checks if the buffer automatically grows as data is added.

  • get_buffer_size ()

    Gets the size of the buffer in the @stream.

  • set_auto_grow (bool auto_grow)

    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.
    • @p auto_grow is a #gboolean..
    • @r None.
  • set_buffer_size (int size)

    Sets the size of the internal buffer to @size.

    • @p size is a #gsize..
    • @r None.