FileInputStream

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

GFileInputStream implements GSeekable, 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 g_seekable_tell(). To find out if a file input stream supports seeking, use g_seekable_can_seek(). To position a file input stream, use g_seekable_seek().

class FileInputStream : InputStream , SeekableIF {

protected

GFileInputStream* gFileInputStream;

GFileInputStream* getFileInputStreamStruct(bool transferOwnership);

void* getStruct();

this(GFileInputStream* gFileInputStream, bool ownedRef);

static GType getType();

FileInfo queryInfo(string attributes, Cancellable cancellable);

void queryInfoAsync(string attributes, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData);

FileInfo queryInfoFinish(AsyncResultIF result);

}

Constructors

this this(GFileInputStream* gFileInputStream, bool ownedRef): Sets our main struct and passes it to the parent class.

Members

Functions

getFileInputStreamStruct GFileInputStream* getFileInputStreamStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
queryInfo FileInfo queryInfo(string attributes, Cancellable cancellable): 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 FileInputStream.queryInfoAsync. 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 void queryInfoAsync(string attributes, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Queries the stream information asynchronously. When the operation is finished callback will be called. You can then call FileInputStream.queryInfoFinish to get the result of the operation.
queryInfoFinish FileInfo queryInfoFinish(AsyncResultIF result): Finishes an asynchronous info query operation.

Static functions

getType GType getType()

Variables

gFileInputStream GFileInputStream* gFileInputStream;: the main Gtk struct

Inherited Members

From InputStream

gInputStream GInputStream* gInputStream;: the main Gtk struct
getInputStreamStruct GInputStream* getInputStreamStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
clearPending void clearPending(): Clears the pending flag on stream.
close bool close(Cancellable cancellable): Closes the stream, releasing resources related to it.
closeAsync void closeAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): 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 InputStream.closeFinish to get the result of the operation.
closeFinish bool closeFinish(AsyncResultIF result): Finishes closing a stream asynchronously, started from InputStream.closeAsync.
hasPending bool hasPending(): Checks if an input stream has pending actions.
isClosed bool isClosed(): Checks if an input stream is closed.
read ptrdiff_t read(ubyte[] buffer, Cancellable cancellable): Tries to read count bytes from the stream into the buffer starting at buffer. Will block during this read.
readAll bool readAll(ubyte[] buffer, size_t bytesRead, Cancellable cancellable): Tries to read count bytes from the stream into the buffer starting at buffer. Will block during this read.
readAllAsync void readAllAsync(ubyte[] buffer, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Request an asynchronous read of count bytes from the stream into the buffer starting at buffer.
readAllFinish bool readAllFinish(AsyncResultIF result, size_t bytesRead): Finishes an asynchronous stream read operation started with InputStream.readAllAsync.
readAsync void readAsync(ubyte[] buffer, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Request an asynchronous read of count bytes from the stream into the buffer starting at buffer. When the operation is finished callback will be called. You can then call InputStream.readFinish to get the result of the operation.
readBytes Bytes readBytes(size_t count, Cancellable cancellable): Like InputStream.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 glib.Bytes containing the data that was read. This may be easier to use from language bindings.
readBytesAsync void readBytesAsync(size_t count, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Request an asynchronous read of count bytes from the stream into a new glib.Bytes When the operation is finished callback will be called. You can then call InputStream.readBytesFinish to get the result of the operation.
readBytesFinish Bytes readBytesFinish(AsyncResultIF result): Finishes an asynchronous stream read-into-glib.Bytes operation.
readFinish ptrdiff_t readFinish(AsyncResultIF result): Finishes an asynchronous stream read operation.
setPending bool setPending(): Sets stream to have actions pending. If the pending flag is already set or stream is closed, it will return FALSE and set error.
skip ptrdiff_t skip(size_t count, Cancellable cancellable): Tries to skip count bytes from the stream. Will block during the operation.
skipAsync void skipAsync(size_t count, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Request an asynchronous skip of count bytes from the stream. When the operation is finished callback will be called. You can then call InputStream.skipFinish to get the result of the operation.
skipFinish ptrdiff_t skipFinish(AsyncResultIF result): Finishes a stream skip operation.

From SeekableIF

getSeekableStruct GSeekable* getSeekableStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
canSeek bool canSeek(): Tests if the stream supports the GSeekableIface
canTruncate bool canTruncate(): Tests if the length of the stream can be adjusted with g_seekable_truncate().
seek bool seek(long offset, GSeekType type, Cancellable cancellable): Seeks in the stream by the given offset, modified by type.
tell long tell(): Tells the current position within the stream.
truncate bool truncate(long offset, Cancellable cancellable): 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 previouly shorter than offset, it is extended with NUL ('\0') bytes.

gio FileInputStream classes

FileInputStream