FileOutputStream

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().

class FileOutputStream : OutputStream , SeekableIF {

protected

GFileOutputStream* gFileOutputStream;

GFileOutputStream* getFileOutputStreamStruct(bool transferOwnership);

void* getStruct();

this(GFileOutputStream* gFileOutputStream, bool ownedRef);

static GType getType();

string getEtag();

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(GFileOutputStream* gFileOutputStream, bool ownedRef): Sets our main struct and passes it to the parent class.

Members

Functions

getEtag string getEtag(): 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.
getFileOutputStreamStruct GFileOutputStream* getFileOutputStreamStruct(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 output stream for the given attributes. This function blocks while querying the stream. For the asynchronous version of this function, see FileOutputStream.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): Asynchronously queries the stream for a gio.FileInfo When completed, callback will be called with a GAsyncResult which can be used to finish the operation with FileOutputStream.queryInfoFinish.
queryInfoFinish FileInfo queryInfoFinish(AsyncResultIF result): Finalizes the asynchronous query started by FileOutputStream.queryInfoAsync.

Static functions

getType GType getType()

Variables

gFileOutputStream GFileOutputStream* gFileOutputStream;: the main Gtk struct

Inherited Members

From OutputStream

gOutputStream GOutputStream* gOutputStream;: the main Gtk struct
getOutputStreamStruct GOutputStream* getOutputStreamStruct(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 close of the stream, releasing resources related to it. When the operation is finished callback will be called. You can then call OutputStream.closeFinish to get the result of the operation.
closeFinish bool closeFinish(AsyncResultIF result): Closes an output stream.
flush bool flush(Cancellable cancellable): Forces a write of all user-space buffered data for the given stream. Will block during the operation. Closing the stream will implicitly cause a flush.
flushAsync void flushAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Forces an asynchronous write of all user-space buffered data for the given stream. For behaviour details see OutputStream.flush.
flushFinish bool flushFinish(AsyncResultIF result): Finishes flushing an output stream.
hasPending bool hasPending(): Checks if an output stream has pending actions.
isClosed bool isClosed(): Checks if an output stream has already been closed.
isClosing bool isClosing(): 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.
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.
splice ptrdiff_t splice(InputStream source, GOutputStreamSpliceFlags flags, Cancellable cancellable): Splices an input stream into an output stream.
spliceAsync void spliceAsync(InputStream source, GOutputStreamSpliceFlags flags, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Splices a stream asynchronously. When the operation is finished callback will be called. You can then call OutputStream.spliceFinish to get the result of the operation.
spliceFinish ptrdiff_t spliceFinish(AsyncResultIF result): Finishes an asynchronous stream splice operation.
vprintf bool vprintf(size_t bytesWritten, Cancellable cancellable, ErrorG error, string format, void* args): This is a utility function around OutputStream.writeAll. It uses g_strdup_vprintf() to turn format and args into a string that is then written to stream.
write ptrdiff_t write(ubyte[] buffer, Cancellable cancellable): Tries to write count bytes from buffer into the stream. Will block during the operation.
writeAll bool writeAll(ubyte[] buffer, size_t bytesWritten, Cancellable cancellable): Tries to write count bytes from buffer into the stream. Will block during the operation.
writeAllAsync void writeAllAsync(ubyte[] buffer, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call OutputStream.writeAllFinish to get the result of the operation.
writeAllFinish bool writeAllFinish(AsyncResultIF result, size_t bytesWritten): Finishes an asynchronous stream write operation started with OutputStream.writeAllAsync.
writeAsync void writeAsync(ubyte[] buffer, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call OutputStream.writeFinish to get the result of the operation.
writeBytes ptrdiff_t writeBytes(Bytes bytes, Cancellable cancellable): A wrapper function for OutputStream.write which takes a glib.Bytes as input. This can be more convenient for use by language bindings or in other cases where the refcounted nature of glib.Bytes is helpful over a bare pointer interface.
writeBytesAsync void writeBytesAsync(Bytes bytes, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): This function is similar to OutputStream.writeAsync, but takes a glib.Bytes as input. Due to the refcounted nature of glib.Bytes, this allows the stream to avoid taking a copy of the data.
writeBytesFinish ptrdiff_t writeBytesFinish(AsyncResultIF result): Finishes a stream write-from-glib.Bytes operation.
writeFinish ptrdiff_t writeFinish(AsyncResultIF result): Finishes a stream write operation.
writev bool writev(GOutputVector[] vectors, size_t bytesWritten, Cancellable cancellable): Tries to write the bytes contained in the n_vectors vectors into the stream. Will block during the operation.
writevAll bool writevAll(GOutputVector[] vectors, size_t bytesWritten, Cancellable cancellable): Tries to write the bytes contained in the n_vectors vectors into the stream. Will block during the operation.
writevAllAsync void writevAllAsync(GOutputVector[] vectors, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Request an asynchronous write of the bytes contained in the n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call OutputStream.writevAllFinish to get the result of the operation.
writevAllFinish bool writevAllFinish(AsyncResultIF result, size_t bytesWritten): Finishes an asynchronous stream write operation started with OutputStream.writevAllAsync.
writevAsync void writevAsync(GOutputVector[] vectors, int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Request an asynchronous write of the bytes contained in n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call OutputStream.writevFinish to get the result of the operation.
writevFinish bool writevFinish(AsyncResultIF result, size_t bytesWritten): Finishes a stream writev 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 FileOutputStream classes

FileOutputStream