gio/org.gtkkn.bindings.gio/BufferedOutputStream

BufferedOutputStream

open class BufferedOutputStream(pointer: <Error class: unknown class><<Error class: unknown class>>) : FilterOutputStream, Seekable

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.

Constructors

BufferedOutputStream

constructor(baseStream: OutputStream)

Creates a new buffered output stream for a base stream.

constructor(baseStream: OutputStream, size: <Error class: unknown class>)

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

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

autoGrow

open var autoGrow: Boolean

Whether the buffer should automatically grow.

baseStream

open val baseStream: OutputStream

bufferSize

open var bufferSize: <Error class: unknown class>

The size of the backend buffer, in bytes.

closeBaseStream

open val closeBaseStream: Boolean

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

gioBufferedOutputStreamPointer

val gioBufferedOutputStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioFilterOutputStreamPointer

val gioFilterOutputStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioOutputStreamPointer

val gioOutputStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioSeekablePointer

open override val gioSeekablePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

canSeek

open fun canSeek(): Boolean

Tests if the stream supports the #GSeekableIface.

canTruncate

open fun canTruncate(): Boolean

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

clearPending

open fun clearPending()

Clears the pending flag on @stream.

open fun close(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Closes the stream, releasing resources related to it.

closeAsync

open fun closeAsync(ioPriority: <Error class: unknown class>, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

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.

closeFinish

open fun closeFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Closes an output stream.

flush

open fun flush(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Forces a write of all user-space buffered data for the given

flushAsync

open fun flushAsync(ioPriority: <Error class: unknown class>, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

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

flushFinish

open fun flushFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes flushing an output stream.

hasPending

open fun hasPending(): Boolean

Checks if an output stream has pending actions.

isClosed

open fun isClosed(): Boolean

Checks if an output stream has already been closed.

isClosing

open fun isClosing(): 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.

seek

open fun seek(offset: <Error class: unknown class>, type: <Error class: unknown class>, cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Seeks in the stream by the given @offset, modified by @type.

setCloseBaseStream

open fun setCloseBaseStream(closeBase: Boolean)

Sets whether the base stream will be closed when @stream is closed.

setPending

open fun setPending(): <Error class: unknown class><Boolean>

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

splice

open fun splice(source: InputStream, flags: OutputStreamSpliceFlags, cancellable: Cancellable? = null): <Error class: unknown class><Long>

Splices an input stream into an output stream.

spliceAsync

open fun spliceAsync(source: InputStream, flags: OutputStreamSpliceFlags, ioPriority: <Error class: unknown class>, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

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.

spliceFinish

open fun spliceFinish(result: AsyncResult): <Error class: unknown class><Long>

Finishes an asynchronous stream splice operation.

tell

open fun tell(): <Error class: unknown class>

Tells the current position within the stream.

truncate

open fun truncate(offset: <Error class: unknown class>, cancellable: Cancellable? = null): <Error class: unknown class><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.

writeBytes

open fun writeBytes(bytes: <Error class: unknown class>, cancellable: Cancellable? = null): <Error class: unknown class><Long>

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.

writeBytesAsync

open fun writeBytesAsync(bytes: <Error class: unknown class>, ioPriority: <Error class: unknown class>, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

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.

writeBytesFinish

open fun writeBytesFinish(result: AsyncResult): <Error class: unknown class><Long>

Finishes a stream write-from-#GBytes operation.

writeFinish

open fun writeFinish(result: AsyncResult): <Error class: unknown class><Long>

Finishes a stream write operation.