FileOutputStream

open class FileOutputStream(    val gioFileOutputStreamPointer: <Error class: unknown class><<Error class: unknown class>>) : OutputStream, Seekable(source)

GFileOutputStream provides output streams that write their content to a file.

GFileOutputStream implements iface@Gio.Seekable, which allows the output stream to jump to arbitrary positions in the file and to truncate the file, provided the filesystem of the file supports these operations.

To find the position of a file output stream, use method@Gio.Seekable.tell. To find out if a file output stream supports seeking, use method@Gio.Seekable.can_seek.To position a file output stream, use method@Gio.Seekable.seek. To find out if a file output stream supports truncating, use method@Gio.Seekable.can_truncate. To truncate a file output stream, use method@Gio.Seekable.truncate.

Constructors

Link copied to clipboard
constructor(gioFileOutputStreamPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gioFileOutputStreamPointer: <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
abstract val gioProxyPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gioSeekablePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun canSeek(): Boolean

Tests if the stream supports the #GSeekableIface.

Link copied to clipboard
open fun canTruncate(): Boolean

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

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 connect(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null): <Error class: unknown class><IoStream>

Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload.

Link copied to clipboard
open fun connectAsync(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Asynchronous version of g_proxy_connect().

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

See g_proxy_connect().

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 getEtag(): String?

Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing.

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 queryInfo(attributes: String, cancellable: Cancellable? = null): <Error class: unknown class><FileInfo>

Queries a file output stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_output_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will fail with %G_IO_ERROR_PENDING.

Link copied to clipboard
open fun queryInfoAsync(attributes: String, ioPriority: <Error class: unknown class>, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Asynchronously queries the @stream for a #GFileInfo. When completed,

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

Finalizes the asynchronous query started by g_file_output_stream_query_info_async().

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

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

Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return false if @proxy is implementing such a protocol. When false is returned, the caller should resolve the destination hostname first, and then pass a #GProxyAddress containing the stringified IP address to g_proxy_connect() or g_proxy_connect_async().

Link copied to clipboard
open fun tell(): <Error class: unknown class>

Tells the current position within the stream.

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

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.