gio/org.gtkkn.bindings.gio/FileInputStream

FileInputStream

open class FileInputStream(pointer: <Error class: unknown class><<Error class: unknown class>>) : InputStream, Seekable

GFileInputStream provides input streams that take their content from a file.

GFileInputStream implements iface@Gio.Seekable, which allows the input stream to jump to arbitrary positions in the file, provided the filesystem of the file allows it. To find the position of a file input stream, use method@Gio.Seekable.tell. To find out if a file input stream supports seeking, use vfunc@Gio.Seekable.can_seek. To position a file input stream, use vfunc@Gio.Seekable.seek.

Constructors

FileInputStream

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

Types

Companion

object Companion

Properties

gioFileInputStreamPointer

val gioFileInputStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioInputStreamPointer

val gioInputStreamPointer: <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 closes of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation.

closeFinish

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

Finishes closing a stream asynchronously, started from g_input_stream_close_async().

hasPending

open fun hasPending(): Boolean

Checks if an input stream has pending actions.

isClosed

open fun isClosed(): Boolean

Checks if an input stream is closed.

queryInfo

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

Queries a file input stream the given @attributes. This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see g_file_input_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: <Error class: unknown class>, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Queries the stream information asynchronously. When the operation is finished @callback will be called. You can then call g_file_input_stream_query_info_finish() to get the result of the operation.

queryInfoFinish

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

Finishes an asynchronous info query operation.

readBytes

open fun readBytes(count: <Error class: unknown class>, cancellable: Cancellable? = null): <Error class: unknown class><<Error class: unknown class>>

Like g_input_stream_read(), this tries to read @count bytes from the stream in a blocking fashion. However, rather than reading into a user-supplied buffer, this will create a new #GBytes containing the data that was read. This may be easier to use from language bindings.

readBytesAsync

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

Request an asynchronous read of @count bytes from the stream into a new #GBytes. When the operation is finished @callback will be called. You can then call g_input_stream_read_bytes_finish() to get the result of the operation.

readBytesFinish

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

Finishes an asynchronous stream read-into-#GBytes operation.

readFinish

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

Finishes an asynchronous stream read 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.

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

skip

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

Tries to skip @count bytes from the stream. Will block during the operation.

skipAsync

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

Request an asynchronous skip of @count bytes from the stream. When the operation is finished @callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation.

skipFinish

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

Finishes a stream skip 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.