Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.InputStream
Gio.FilterInputStream

Class Gio.FilterInputStream

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GFilterInputStream
Class :	FilterInputStream
Subclasses:	Gio.BufferedInputStream, Gio.ConverterInputStream, Gio.DataInputStream
Extends:	Gio.InputStream

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.

Properties
Properties		Defined By
	base_stream : Gio.InputStream	Gio.FilterInputStream
	base_stream : Gio.InputStream read only	Gio.FilterInputStream
	close_base_stream : gboolean	Gio.FilterInputStream
	parent_instance : Gio.InputStream read only	Gio.FilterInputStream
	priv : Gio.InputStreamPrivate read only	Gio.InputStream

Methods / Constructors
Method / Constructor		Defined By
	new Gio.FilterInputStream (Object *properties) Create a new Gio.FilterInputStream Create a new Gio.FilterInputStream Parameters: Object properties*
	clear_pending () : none Clears the pending flag on stream. Clears the pending flag on stream. Returns: none	Gio.InputStream
	close (Cancellable *cancellable) : gboolean Closes the stream, releasing resources related to it. Closes the stream, releasing resources related to it. Once the stream is closed, all other operations will return G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error. Streams will be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible. Some streams might keep the backing store of the stream (e.g. a file descriptor) open after the stream is closed. See the documentation for the individual stream for details. On failure the first error that happened will be reported, but the close operation will finish as much as possible. A stream that failed to close will still return G_IO_ERROR_CLOSED* for all operations. Still, it is important to check and report the error to the user. If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned. Cancelling a close will still leave the stream closed, but some streams can use a faster close that doesn't block to e.g. check errors. Parameters: Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Returns: gboolean TRUE on success, FALSE on failure	Gio.InputStream
	close_async (gint32 *io_priority, Cancellable cancellable, Function callback, void *user_data) : none Requests an asynchronous closes of the stream, releasing resources related to it. 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. For behaviour details see g_input_stream_close(). The asyncronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. Parameters: gint32 io_priority Required (not null) the I/O priority of the request. Gio.Cancellable cancellable optional cancellable object Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) callback to call when the request is satisfied void user_data Required (not null) the data to pass to callback function Returns: none	Gio.InputStream
	close_finish (AsyncResult *result) : gboolean Finishes closing a stream asynchronously, started from g_input_stream_close_async(). Finishes closing a stream asynchronously, started from g_input_stream_close_async(). Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Returns: gboolean TRUE if the stream was closed successfully.	Gio.InputStream
	get_base_stream () : Gio.InputStream Gets the base stream for the filter stream. Gets the base stream for the filter stream. Returns: Gio.InputStream a GInputStream.	Gio.FilterInputStream
	get_close_base_stream () : gboolean Returns whether the base stream will be closed when stream is closed. Returns whether the base stream will be closed when stream is closed. Returns: gboolean TRUE if the base stream will be closed.	Gio.FilterInputStream
	has_pending () : gboolean Checks if an input stream has pending actions. Checks if an input stream has pending actions. Returns: gboolean TRUE if stream has pending actions.	Gio.InputStream
	is_closed () : gboolean Checks if an input stream is closed. Checks if an input stream is closed. Returns: gboolean TRUE if the stream is closed.	Gio.InputStream
	read (void* *buffer, guint32 count, Cancellable cancellable) : gint32 Tries to read count* bytes from the stream into the buffer starting at If count is zero returns zero and does nothing. Tries to read count bytes from the stream into the buffer starting at If count is zero returns zero and does nothing. A value of count larger than G_MAXSSIZE will cause a G_IO_ERROR_INVALID_ARGUMENT error. On success, the number of bytes read into the buffer is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. near the end of a file. Zero is returned on end of file (or if count is zero), but never otherwise. If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error. On error -1 is returned and error is set accordingly. Parameters: void* buffer Required (not null) a buffer to read data into (which should be at least count bytes long). guint32 count Required (not null) the number of bytes that will be read from the stream Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Returns: gint32 Number of bytes read, or -1 on error	Gio.InputStream
	read_all (void* *buffer, guint32 count, Object out_values, Cancellable cancellable) : gboolean Tries to read count* bytes from the stream into the buffer starting at This function is similar to g_input_stream_read(), except it tries to read as many bytes as requested, only stopping on an error or end of stream. Tries to read count bytes from the stream into the buffer starting at This function is similar to g_input_stream_read(), except it tries to read as many bytes as requested, only stopping on an error or end of stream. On a successful read of count bytes, or if we reached the end of the stream, TRUE is returned, and bytes_read is set to the number of bytes read into buffer. If there is an error during the operation FALSE is returned and error is set to indicate the error status, bytes_read is updated to contain the number of bytes read into buffer before the error occurred. Parameters: void* buffer Required (not null) a buffer to read data into (which should be at least count bytes long). guint32 count Required (not null) the number of bytes that will be read from the stream Object out_values guint32 bytes_read Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Returns: gboolean TRUE on success, FALSE if there was an error	Gio.InputStream
	read_async (void* *buffer, guint32 count, gint32 io_priority, Cancellable cancellable, Function callback, void *user_data) : none Request an asynchronous read of count* bytes from the stream into the buffer starting at buffer. 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 g_input_stream_read_finish() to get the result of the operation. During an async request no other sync and async calls are allowed on stream, and will result in G_IO_ERROR_PENDING errors. A value of count larger than G_MAXSSIZE will cause a G_IO_ERROR_INVALID_ARGUMENT error. On success, the number of bytes read into the buffer will be passed to the callback. It is not an error if this is not the same as the requested size, as it can happen e.g. near the end of a file, but generally we try to read as many bytes as requested. Zero is returned on end of file (or if count is zero), but never otherwise. Any outstanding i/o request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is G_PRIORITY_DEFAULT. The asyncronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. Parameters: void* buffer Required (not null) a buffer to read data into (which should be at least count bytes long). guint32 count Required (not null) the number of bytes that will be read from the stream gint32 io_priority Required (not null) the I/O priority of the request. Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) callback to call when the request is satisfied void user_data Required (not null) the data to pass to callback function Returns: none	Gio.InputStream
	read_finish (AsyncResult *result) : gint32 Finishes an asynchronous stream read operation. Finishes an asynchronous stream read operation. Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Returns: gint32 number of bytes read in, or -1 on error.	Gio.InputStream
	set_close_base_stream (gboolean *close_base) : none Sets whether the base stream will be closed when stream* is closed. Sets whether the base stream will be closed when stream is closed. Parameters: gboolean close_base Required (not null) TRUE to close the base stream. Returns: none	Gio.FilterInputStream
	set_pending () : gboolean Sets stream to have actions pending. Sets stream to have actions pending. If the pending flag is already set or stream is closed, it will return FALSE and set Returns: gboolean TRUE if pending was previously unset and is now set.	Gio.InputStream
	skip (guint32 *count, Cancellable cancellable) : gint32 Tries to skip count* bytes from the stream. Tries to skip count bytes from the stream. Will block during the operation. This is identical to g_input_stream_read(), from a behaviour standpoint, but the bytes that are skipped are not returned to the user. Some streams have an implementation that is more efficient than reading the data. This function is optional for inherited classes, as the default implementation emulates it using read. If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error. Parameters: guint32 count Required (not null) the number of bytes that will be skipped from the stream Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Returns: gint32 Number of bytes skipped, or -1 on error	Gio.InputStream
	skip_async (guint32 *count, gint32 io_priority, Cancellable cancellable, Function callback, void *user_data) : none Request an asynchronous skip of count* bytes from the stream. 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. During an async request no other sync and async calls are allowed, and will result in G_IO_ERROR_PENDING errors. A value of count larger than G_MAXSSIZE will cause a G_IO_ERROR_INVALID_ARGUMENT error. On success, the number of bytes skipped will be passed to the callback. It is not an error if this is not the same as the requested size, as it can happen e.g. near the end of a file, but generally we try to skip as many bytes as requested. Zero is returned on end of file (or if count is zero), but never otherwise. Any outstanding i/o request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is G_PRIORITY_DEFAULT. The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one, you must override all. Parameters: guint32 count Required (not null) the number of bytes that will be skipped from the stream gint32 io_priority Required (not null) the I/O priority of the request. Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) callback to call when the request is satisfied void user_data Required (not null) the data to pass to callback function Returns: none	Gio.InputStream
	skip_finish (AsyncResult *result) : gint32 Finishes a stream skip operation. Finishes a stream skip operation. Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Returns: gint32 the size of the bytes skipped, or %-1 on error.	Gio.InputStream

Events
None

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Sat Apr 16 2011 17:11:12 GMT+0800 (HKT)