From f605811afe8c91f121e89b6f9ec28c70b62f4110 Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Mon, 1 Jun 2009 22:40:56 +0200 Subject: Wrap gio.FileInputStream.query_async Add the wrapper for gio.FileInputStream.query_async including docs and a test. --- docs/reference/pygio-classes.xml | 1 + docs/reference/pygio-fileinputstream.xml | 221 +++++++++++++++++++++++++++++++ 2 files changed, 222 insertions(+) create mode 100644 docs/reference/pygio-fileinputstream.xml (limited to 'docs/reference') diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml index c4869ca..4f2cfb2 100644 --- a/docs/reference/pygio-classes.xml +++ b/docs/reference/pygio-classes.xml @@ -19,6 +19,7 @@ + diff --git a/docs/reference/pygio-fileinputstream.xml b/docs/reference/pygio-fileinputstream.xml new file mode 100644 index 0000000..f22b60a --- /dev/null +++ b/docs/reference/pygio-fileinputstream.xml @@ -0,0 +1,221 @@ + + + + + + gio.FileInputStream + Base class for implementing streaming input + + + + Synopsis + + + gio.FileInputStream + gio.InputStream + + + query_info + attributes + cancellableNone + + + query_info_async + attributes + callback + io_priorityglib.PRIORITY_DEFAULT + cancellableNone + user_dataNone + + + query_info_finish + result + + + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.InputStream + +-- gio.FileInputStream + + + + + + Description + + + gio.FileInputStream + provides input streams that take their content from a file. + + + gio.FileInputStream + implements gio.Seekable, + which allows the input stream to jump to arbitrary positions in the file, provided the filesystem + of the file allows it. In addition to the generic g_seekable_ API, + gio.FileInputStream + has its own API for seeking and positioning. To find the position of a file input stream, use + gio.Seekable.tell(). + To find out if a file input stream supports seeking, use + gio.Seekable.can_seek(). + To position a file input stream, use + gio.Seekable.seek(). + + + + + Methods + + + gio.FileInputStream.clear_pending + + + clear_pending + + + + + + + + The clear_pending() method clears the pending flag on stream. + + + + + gio.FileInputStream.query_info + + + query_info + attributes + cancellableNone + + + + + attributes : + a file attribute query string. + + + + cancellable : + optional + gio.Cancellable + object, None to ignore. + + + + Returns : + a gio.FileInfo, + or None on error. + + + + + + The query_info() method 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 + gio.FileInputStream.query_info_async(). + While the stream is blocked, the stream will set the pending flag internally, + and any other operations on the stream will fail with gio.ERROR_PENDING. + + + + + gio.FileInputStream.query_info_async + + + query_info_async + attributes + callback + io_priorityglib.PRIORITY_DEFAULT + cancellableNone + user_dataNone + + + + + attributes : + a file attribute query string. + + + + callback : + a GAsyncReadyCallback to call when the request is satisfied. + + + + io_priority : + the + + of the request. + + + + cancellable : + optional + gio.Cancellable + object, None to ignore. + + + user_data : + the data to pass to callback function. + + + + + + The query_info_async() method queries the stream + information asynchronously. When the operation is finished callback will be + called. You can then call + gio.FileInputStream.query_info_finish() + to get the result of the operation. + + + For the synchronous version of this function, see + gio.FileInputStream.query_info(). + + + If cancellable is not None, then the operation can be cancelled + by triggering the cancellable object from another thread. If the operation was + cancelled, the error gio.ERROR_CANCELLED will be set + + + + + gio.FileInputStream.query_info_finish + + + query_info_finish + result + + + + + result : + a gio.AsyncResult. + + + + Returns : + a gio.FileInfo, + or None on error. + + + + + + The query_info_finish() method finishes an asynchronous + file append operation started with + gio.FileInputStream.query_info_async(). + + + + -- cgit