FilterInputStream

Base class for input 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.

class FilterInputStream : InputStream {

protected

GFilterInputStream* gFilterInputStream;

GFilterInputStream* getFilterInputStreamStruct(bool transferOwnership);

void* getStruct();

this(GFilterInputStream* gFilterInputStream, bool ownedRef);

static GType getType();

InputStream getBaseStream();

bool getCloseBaseStream();

void setCloseBaseStream(bool closeBase);

}

Constructors

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

Members

Functions

getBaseStream InputStream getBaseStream(): Gets the base stream for the filter stream.
getCloseBaseStream bool getCloseBaseStream(): Returns whether the base stream will be closed when stream is closed.
getFilterInputStreamStruct GFilterInputStream* getFilterInputStreamStruct(bool transferOwnership): 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

gFilterInputStream GFilterInputStream* gFilterInputStream;: 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.

gio FilterInputStream classes

FilterInputStream