1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::ffi;
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// `GAsyncResult` provides a base class for implementing asynchronous function results.
    ///
    /// Asynchronous operations are broken up into two separate operations
    /// which are chained together by a `GAsyncReadyCallback`. To begin
    /// an asynchronous operation, provide a `GAsyncReadyCallback` to the
    /// asynchronous function. This callback will be triggered when the
    /// operation has completed, and must be run in a later iteration of
    /// the thread-default main context (see
    /// [`glib::MainContext::push_thread_default()`][crate::glib::MainContext::push_thread_default()]) from where the operation was
    /// initiated. It will be passed a `GAsyncResult` instance filled with the
    /// details of the operation's success or failure, the object the asynchronous
    /// function was started for and any error codes returned. The asynchronous
    /// callback function is then expected to call the corresponding `_finish()`
    /// function, passing the object the function was called for, the
    /// `GAsyncResult` instance, and (optionally) an @error to grab any
    /// error conditions that may have occurred.
    ///
    /// The `_finish()` function for an operation takes the generic result
    /// (of type `GAsyncResult`) and returns the specific result that the
    /// operation in question yields (e.g. a [`FileEnumerator`][crate::FileEnumerator] for a
    /// "enumerate children" operation). If the result or error status of the
    /// operation is not needed, there is no need to call the `_finish()`
    /// function; GIO will take care of cleaning up the result and error
    /// information after the `GAsyncReadyCallback` returns. You can pass
    /// `NULL` for the `GAsyncReadyCallback` if you don't need to take any
    /// action at all after the operation completes. Applications may also
    /// take a reference to the `GAsyncResult` and call `_finish()` later;
    /// however, the `_finish()` function may be called at most once.
    ///
    /// Example of a typical asynchronous operation flow:
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// void _theoretical_frobnitz_async (Theoretical         *t,
    ///                                   GCancellable        *c,
    ///                                   GAsyncReadyCallback  cb,
    ///                                   gpointer             u);
    ///
    /// gboolean _theoretical_frobnitz_finish (Theoretical   *t,
    ///                                        GAsyncResult  *res,
    ///                                        GError       **e);
    ///
    /// static void
    /// frobnitz_result_func (GObject      *source_object,
    ///          GAsyncResult *res,
    ///          gpointer      user_data)
    /// {
    ///   gboolean success = FALSE;
    ///
    ///   success = _theoretical_frobnitz_finish (source_object, res, NULL);
    ///
    ///   if (success)
    ///     g_printf ("Hurray!\n");
    ///   else
    ///     g_printf ("Uh oh!\n");
    ///
    ///   ...
    ///
    /// }
    ///
    /// int main (int argc, void *argv[])
    /// {
    ///    ...
    ///
    ///    _theoretical_frobnitz_async (theoretical_data,
    ///                                 NULL,
    ///                                 frobnitz_result_func,
    ///                                 NULL);
    ///
    ///    ...
    /// }
    /// ```
    ///
    /// The callback for an asynchronous operation is called only once, and is
    /// always called, even in the case of a cancelled operation. On cancellation
    /// the result is a `G_IO_ERROR_CANCELLED` error.
    ///
    /// ## I/O Priority
    ///
    /// Many I/O-related asynchronous operations have a priority parameter,
    /// which is used in certain cases to determine the order in which
    /// operations are executed. They are not used to determine system-wide
    /// I/O scheduling. Priorities are integers, with lower numbers indicating
    /// higher priority. It is recommended to choose priorities between
    /// `G_PRIORITY_LOW` and `G_PRIORITY_HIGH`, with `G_PRIORITY_DEFAULT`
    /// as a default.
    ///
    /// # Implements
    ///
    /// [`AsyncResultExt`][trait@crate::prelude::AsyncResultExt]
    #[doc(alias = "GAsyncResult")]
    pub struct AsyncResult(Interface<ffi::GAsyncResult, ffi::GAsyncResultIface>);

    match fn {
        type_ => || ffi::g_async_result_get_type(),
    }
}

impl AsyncResult {
    pub const NONE: Option<&'static AsyncResult> = None;
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::AsyncResult>> Sealed for T {}
}

/// Trait containing all [`struct@AsyncResult`] methods.
///
/// # Implementors
///
/// [`AsyncResult`][struct@crate::AsyncResult], [`Task`][struct@crate::Task]
pub trait AsyncResultExt: IsA<AsyncResult> + sealed::Sealed + 'static {
    /// Gets the source object from a #GAsyncResult.
    ///
    /// # Returns
    ///
    /// a new reference to the source
    ///    object for the @self, or [`None`] if there is none.
    #[doc(alias = "g_async_result_get_source_object")]
    #[doc(alias = "get_source_object")]
    fn source_object(&self) -> Option<glib::Object> {
        unsafe {
            from_glib_full(ffi::g_async_result_get_source_object(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    //#[doc(alias = "g_async_result_get_user_data")]
    //#[doc(alias = "get_user_data")]
    //fn user_data(&self) -> /*Unimplemented*/Option<Basic: Pointer> {
    //    unsafe { TODO: call ffi:g_async_result_get_user_data() }
    //}

    //#[doc(alias = "g_async_result_is_tagged")]
    //fn is_tagged(&self, source_tag: /*Unimplemented*/Option<Basic: Pointer>) -> bool {
    //    unsafe { TODO: call ffi:g_async_result_is_tagged() }
    //}

    /// If @self is a #GSimpleAsyncResult, this is equivalent to
    /// g_simple_async_result_propagate_error(). Otherwise it returns
    /// [`false`].
    ///
    /// This can be used for legacy error handling in async *_finish()
    /// wrapper functions that traditionally handled #GSimpleAsyncResult
    /// error returns themselves rather than calling into the virtual method.
    /// This should not be used in new code; #GAsyncResult errors that are
    /// set by virtual methods should also be extracted by virtual methods,
    /// to enable subclasses to chain up correctly.
    ///
    /// # Returns
    ///
    /// [`true`] if @error is has been filled in with an error from
    ///   @self, [`false`] if not.
    #[doc(alias = "g_async_result_legacy_propagate_error")]
    fn legacy_propagate_error(&self) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::g_async_result_legacy_propagate_error(
                self.as_ref().to_glib_none().0,
                &mut error,
            );
            debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }
}

impl<O: IsA<AsyncResult>> AsyncResultExt for O {}