:right-sidebar: True SimpleAsyncResult =================================================================== .. currentmodule:: gi.repository.Gio .. class:: SimpleAsyncResult(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` Implemented Interfaces: :class:`~gi.repository.Gio.AsyncResult` :Constructors: :: SimpleAsyncResult(**properties) new(source_object:GObject.Object=None, callback:Gio.AsyncReadyCallback=None, user_data=None, source_tag=None) -> Gio.SimpleAsyncResult new_from_error(source_object:GObject.Object=None, callback:Gio.AsyncReadyCallback=None, user_data=None, error:error) -> Gio.SimpleAsyncResult Constructors ------------ .. rst-class:: interim-class .. class:: SimpleAsyncResult :no-index: .. classmethod:: new(source_object: ~gi.repository.GObject.Object | None, callback: ~typing.Callable[[...], None] | None, source_tag: None, *user_data: ~typing.Any) -> ~gi.repository.Gio.SimpleAsyncResult Creates a :obj:`~gi.repository.Gio.SimpleAsyncResult`. The common convention is to create the :obj:`~gi.repository.Gio.SimpleAsyncResult` in the function that starts the asynchronous operation and use that same function as the ``source_tag``. If your operation supports cancellation with :obj:`~gi.repository.Gio.Cancellable` (which it probably should) then you should provide the user's cancellable to :func:`~gi.repository.Gio.SimpleAsyncResult.set_check_cancellable` immediately after this function returns. .. deprecated:: 2.46 Use :func:`~gi.repository.Gio.Task.new` instead. :param source_object: a :obj:`~gi.repository.GObject.Object`, or :const:`None`. :param callback: a :obj:`~gi.repository.Gio.AsyncReadyCallback`. :param source_tag: the asynchronous function. :param user_data: user data passed to ``callback``. .. classmethod:: new_from_error(source_object: ~gi.repository.GObject.Object | None, callback: ~typing.Callable[[...], None] | None, error: ~gi.repository.GLib.GError, *user_data: ~typing.Any) -> ~gi.repository.Gio.SimpleAsyncResult Creates a :obj:`~gi.repository.Gio.SimpleAsyncResult` from an error condition. .. deprecated:: 2.46 Use :func:`~gi.repository.Gio.Task.new` and :func:`~gi.repository.Gio.Task.return_error` instead. :param source_object: a :obj:`~gi.repository.GObject.Object`, or :const:`None`. :param callback: a :obj:`~gi.repository.Gio.AsyncReadyCallback`. :param error: a :obj:`~gi.repository.GLib.Error` :param user_data: user data passed to ``callback``. Methods ------- .. rst-class:: interim-class .. class:: SimpleAsyncResult :no-index: .. method:: complete() -> None Completes an asynchronous I/O job immediately. Must be called in the thread where the asynchronous result was to be delivered, as it invokes the callback directly. If you are in a different thread use :func:`~gi.repository.Gio.SimpleAsyncResult.complete_in_idle`. Calling this function takes a reference to ``simple`` for as long as is needed to complete the call. .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` instead. .. method:: complete_in_idle() -> None Completes an asynchronous function in an idle handler in the [thread-default main context][g-main-context-push-thread-default] of the thread that ``simple`` was initially created in (and re-pushes that context around the invocation of the callback). Calling this function takes a reference to ``simple`` for as long as is needed to complete the call. .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` instead. .. method:: get_op_res_gboolean() -> bool Gets the operation result boolean from within the asynchronous result. .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` and :func:`~gi.repository.Gio.Task.propagate_boolean` instead. .. method:: get_op_res_gssize() -> int Gets a gssize from the asynchronous result. .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` and :func:`~gi.repository.Gio.Task.propagate_int` instead. .. method:: is_valid(result: ~gi.repository.Gio.AsyncResult, source: ~gi.repository.GObject.Object | None, source_tag: None) -> bool Ensures that the data passed to the _finish function of an async operation is consistent. Three checks are performed. First, ``result`` is checked to ensure that it is really a :obj:`~gi.repository.Gio.SimpleAsyncResult`. Second, ``source`` is checked to ensure that it matches the source object of ``result``. Third, ``source_tag`` is checked to ensure that it is equal to the ``source_tag`` argument given to :func:`~gi.repository.Gio.SimpleAsyncResult.new` (which, by convention, is a pointer to the _async function corresponding to the _finish function from which this function is called). (Alternatively, if either ``source_tag`` or ``result``'s source tag is :const:`None`, then the source tag check is skipped.) .. versionadded:: 2.20 .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` and :func:`~gi.repository.Gio.Task.is_valid` instead. :param result: the :obj:`~gi.repository.Gio.AsyncResult` passed to the _finish function. :param source: the :obj:`~gi.repository.GObject.Object` passed to the _finish function. :param source_tag: the asynchronous function. .. method:: propagate_error() -> bool Propagates an error from within the simple asynchronous result to a given destination. If the :obj:`~gi.repository.Gio.Cancellable` given to a prior call to :func:`~gi.repository.Gio.SimpleAsyncResult.set_check_cancellable` is cancelled then this function will return :const:`True` with ``dest`` set appropriately. .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` instead. .. method:: set_check_cancellable(check_cancellable: ~gi.repository.Gio.Cancellable | None = None) -> None Sets a :obj:`~gi.repository.Gio.Cancellable` to check before dispatching results. This function has one very specific purpose: the provided cancellable is checked at the time of :func:`~gi.repository.Gio.SimpleAsyncResult.propagate_error` If it is cancelled, these functions will return an "Operation was cancelled" error (:const:`~gi.repository.Gio.IOErrorEnum.CANCELLED`). Implementors of cancellable asynchronous functions should use this in order to provide a guarantee to their callers that cancelling an async operation will reliably result in an error being returned for that operation (even if a positive result for the operation has already been sent as an idle to the main context to be dispatched). The checking described above is done regardless of any call to the unrelated :func:`~gi.repository.Gio.SimpleAsyncResult.set_handle_cancellation` function. .. versionadded:: 2.32 .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` instead. :param check_cancellable: a :obj:`~gi.repository.Gio.Cancellable` to check, or :const:`None` to unset .. method:: set_from_error(error: ~gi.repository.GLib.GError) -> None Sets the result from a :obj:`~gi.repository.GLib.Error`. .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` and :func:`~gi.repository.Gio.Task.return_error` instead. :param error: :obj:`~gi.repository.GLib.Error`. .. method:: set_handle_cancellation(handle_cancellation: bool) -> None Sets whether to handle cancellation within the asynchronous operation. This function has nothing to do with :func:`~gi.repository.Gio.SimpleAsyncResult.set_check_cancellable`. It only refers to the :obj:`~gi.repository.Gio.Cancellable` passed to :func:`~gi.repository.Gio.SimpleAsyncResult.run_in_thread`. .. deprecated:: 2.46 Please do not use it in newly written code :param handle_cancellation: a :obj:`~gi.repository.gboolean`. .. method:: set_op_res_gboolean(op_res: bool) -> None Sets the operation result to a boolean within the asynchronous result. .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` and :func:`~gi.repository.Gio.Task.return_boolean` instead. :param op_res: a :obj:`~gi.repository.gboolean`. .. method:: set_op_res_gssize(op_res: int) -> None Sets the operation result within the asynchronous result to the given ``op_res``. .. deprecated:: 2.46 Use :obj:`~gi.repository.Gio.Task` and :func:`~gi.repository.Gio.Task.return_int` instead. :param op_res: a :obj:`~gi.repository.gssize`.