gio/org.gtkkn.bindings.gio/FileIOStream

FileIOStream

open class FileIOStream(pointer: <Error class: unknown class><<Error class: unknown class>>) : IOStream, Seekable

GFileIOStream provides io streams that both read and write to the same file handle.

GFileIOStream implements #GSeekable, which allows the io 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 io stream, use g_seekable_tell().

To find out if a file io stream supports seeking, use g_seekable_can_seek(). To position a file io stream, use g_seekable_seek(). To find out if a file io stream supports truncating, use g_seekable_can_truncate(). To truncate a file io stream, use g_seekable_truncate().

The default implementation of all the #GFileIOStream operations and the implementation of #GSeekable just call into the same operations on the output stream.

Since

2.22

Constructors

FileIOStream

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

Types

Companion

object Companion

Properties

gioFileIOStreamPointer

val gioFileIOStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioIOStreamPointer

val gioIOStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioSeekablePointer

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

inputStream

open val inputStream: InputStream

outputStream

open val outputStream: OutputStream

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. This will also close the individual input and output streams, if they are not already closed.

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_io_stream_close_finish() to get the result of the operation.

closeFinish

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

Closes a 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.

getInputStream

open fun getInputStream(): InputStream

Gets the input stream for this object. This is used for reading.

getOutputStream

open fun getOutputStream(): OutputStream

Gets the output stream for this object. This is used for writing.

hasPending

open fun hasPending(): Boolean

Checks if a stream has pending actions.

isClosed

open fun isClosed(): Boolean

Checks if a stream is closed.

queryInfo

open fun queryInfo(attributes: String, cancellable: Cancellable? = null): <Error class: unknown class><FileInfo>

Queries a file io stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_io_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_io_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

spliceAsync

open fun spliceAsync(stream2: IOStream, flags: IOStreamSpliceFlags, ioPriority: Int, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Asynchronously splice the output stream of @stream1 to the input stream of

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.