ConverterOutputStream

open class ConverterOutputStream(pointer: <Error class: unknown class><<Error class: unknown class>>) : FilterOutputStream, PollableOutputStream

Converter output stream implements class@Gio.OutputStream and allows conversion of data of various types during reading.

As of GLib 2.34, GConverterOutputStream implements iface@Gio.PollableOutputStream.

Constructors

Link copied to clipboard
constructor(baseStream: OutputStream, converter: Converter)

Creates a new converter output stream for the @base_stream.

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

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The converter object.

Link copied to clipboard
val gioConverterOutputStreamPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gioFilterOutputStreamPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gioOutputStreamPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gioPollableOutputStreamPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun canPoll(): Boolean

Checks if @stream is actually pollable. Some classes may implement #GPollableOutputStream but have only certain instances of that class be pollable. If this method returns false, then the behavior of other #GPollableOutputStream methods is undefined.

Link copied to clipboard
open fun clearPending()

Clears the pending flag on @stream.

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

Closes the stream, releasing resources related to it.

Link copied to clipboard
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.

Link copied to clipboard
open fun closeFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Closes an output stream.

Link copied to clipboard
open fun createSource(cancellable: Cancellable? = null): <Error class: unknown class>

Creates a #GSource that triggers when @stream can be written, or

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

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

Link copied to clipboard
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().

Link copied to clipboard
open fun flushFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes flushing an output stream.

Link copied to clipboard
open fun hasPending(): Boolean

Checks if an output stream has pending actions.

Link copied to clipboard
open fun isClosed(): Boolean

Checks if an output stream has already been closed.

Link copied to clipboard
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.

Link copied to clipboard
open fun isWritable(): Boolean

Checks if @stream can be written.

Link copied to clipboard
open fun setCloseBaseStream(closeBase: Boolean)

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

Link copied to clipboard
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

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

Splices an input stream into an output stream.

Link copied to clipboard
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.

Link copied to clipboard
open fun spliceFinish(result: AsyncResult): <Error class: unknown class><Long>

Finishes an asynchronous stream splice operation.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
open fun writeBytesFinish(result: AsyncResult): <Error class: unknown class><Long>

Finishes a stream write-from-#GBytes operation.

Link copied to clipboard
open fun writeFinish(result: AsyncResult): <Error class: unknown class><Long>

Finishes a stream write operation.