FilterOutputStream

Base class for output stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering operations are character set conversion, compression and byte order flipping.

Constructors

this
this(GFilterOutputStream* gFilterOutputStream, bool ownedRef = false)

Sets our main struct and passes it to the parent class.

Members

Functions

getBaseStream
OutputStream getBaseStream()

Gets the base stream for the filter stream.

getCloseBaseStream
bool getCloseBaseStream()

Returns whether the base stream will be closed when stream is closed.

getFilterOutputStreamStruct
GFilterOutputStream* getFilterOutputStreamStruct(bool transferOwnership = false)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

setCloseBaseStream
void setCloseBaseStream(bool closeBase)

Sets whether the base stream will be closed when stream is closed.

Static functions

getType
GType getType()

Variables

gFilterOutputStream
GFilterOutputStream* gFilterOutputStream;

the main Gtk struct

Inherited Members

From OutputStream

gOutputStream
GOutputStream* gOutputStream;

the main Gtk struct

getOutputStreamStruct
GOutputStream* getOutputStreamStruct(bool transferOwnership = false)

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(out size_t bytesWritten, Cancellable cancellable, out 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, out 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, out 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.

Meta