gio/org.gtkkn.bindings.gio/FileOutputStream

FileOutputStream

open class FileOutputStream(pointer: <Error class: unknown class><<Error class: unknown class>>) : OutputStream, Seekable

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

GFileOutputStream implements #GSeekable, 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 g_seekable_tell(). To find out if a file output stream supports seeking, use g_seekable_can_seek().To position a file output stream, use g_seekable_seek(). To find out if a file output stream supports truncating, use g_seekable_can_truncate(). To truncate a file output stream, use g_seekable_truncate().

Constructors

FileOutputStream

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

Types

Companion

object Companion

Properties

gioFileOutputStreamPointer

val gioFileOutputStreamPointer: <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: Int, 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: Int, 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.

getEtag

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.

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.

queryInfo

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.

queryInfoAsync

open fun queryInfoAsync(attributes: String, ioPriority: Int, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

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

queryInfoFinish

open fun queryInfoFinish(result: AsyncResult): <Error class: unknown class><FileInfo>

Finalizes the asynchronous query started by g_file_output_stream_query_info_async().

seek

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

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

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: Int, 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(): Long

Tells the current position within the stream.

truncate

open fun truncate(offset: Long, 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: Int, 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.