Merge pull request #820 from cgwalters/fix-cancellable

Move `g_cancellable_set_error_if_cancelled()` to manual

Author: sdroege

gio/Gir.toml

@@ -398,6 +398,9 @@ manual_traits = ["CancellableExtManual"]
     name = "cancelled"
     # Racy, use 'connect' and 'disconnect' instead
     ignore = true
+    [[object.function]]
+    name = "set_error_if_cancelled"
+    manual = true
 
 [[object]]
 name = "Gio.CharsetConverter"

gio/src/auto/cancellable.rs

@@ -5,7 +5,6 @@
 use glib::object::IsA;
 use glib::translate::*;
 use std::fmt;
-use std::ptr;
 
 glib::wrapper! {
     #[doc(alias = "GCancellable")]
@@ -62,9 +61,6 @@ pub trait CancellableExt: 'static {
 
     #[doc(alias = "g_cancellable_release_fd")]
     fn release_fd(&self);
-
-    #[doc(alias = "g_cancellable_set_error_if_cancelled")]
-    fn set_error_if_cancelled(&self) -> Result<(), glib::Error>;
 }
 
 impl<O: IsA<Cancellable>> CancellableExt for O {
@@ -107,22 +103,6 @@ impl<O: IsA<Cancellable>> CancellableExt for O {
             ffi::g_cancellable_release_fd(self.as_ref().to_glib_none().0);
         }
     }
-
-    fn set_error_if_cancelled(&self) -> Result<(), glib::Error> {
-        unsafe {
-            let mut error = ptr::null_mut();
-            let is_ok = ffi::g_cancellable_set_error_if_cancelled(
-                self.as_ref().to_glib_none().0,
-                &mut error,
-            );
-            assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
-            if error.is_null() {
-                Ok(())
-            } else {
-                Err(from_glib_full(error))
-            }
-        }
-    }
 }
 
 impl fmt::Display for Cancellable {

gio/src/cancellable.rs

@@ -75,6 +75,10 @@ pub trait CancellableExtManual {
     /// Returns a `Future` that completes when the cancellable becomes cancelled. Completes
     /// immediately if the cancellable is already cancelled.
     fn future(&self) -> std::pin::Pin<Box<dyn Future<Output = ()> + Send + Sync + 'static>>;
+    // rustdoc-stripper-ignore-next
+    /// Set an error if the cancellable is already cancelled.
+    #[doc(alias = "g_cancellable_set_error_if_cancelled")]
+    fn set_error_if_cancelled(&self) -> Result<(), glib::Error>;
 }
 
 impl<O: IsA<Cancellable>> CancellableExtManual for O {
@@ -136,6 +140,24 @@ impl<O: IsA<Cancellable>> CancellableExtManual for O {
             }
         })
     }
+
+    fn set_error_if_cancelled(&self) -> Result<(), glib::Error> {
+        unsafe {
+            let mut error = std::ptr::null_mut();
+            let is_ok = ffi::g_cancellable_set_error_if_cancelled(
+                self.as_ref().to_glib_none().0,
+                &mut error,
+            );
+            // Here's the special case, this function has an inverted
+            // return value for the error case.
+            assert_eq!(is_ok == glib::ffi::GFALSE, error.is_null());
+            if error.is_null() {
+                Ok(())
+            } else {
+                Err(from_glib_full(error))
+            }
+        }
+    }
 }
 
 #[cfg(test)]
@@ -158,6 +180,13 @@ mod tests {
         c.disconnect_cancelled(id.unwrap());
     }
 
+    #[test]
+    fn cancellable_error_if_cancelled() {
+        let c = Cancellable::new();
+        c.cancel();
+        assert!(c.set_error_if_cancelled().is_err());
+    }
+
     #[test]
     fn cancellable_future() {
         let c = Cancellable::new();

gio/src/subclass/async_initable.rs

@@ -9,7 +9,6 @@ use glib::subclass::prelude::*;
 
 use std::ptr;
 
-use crate::prelude::CancellableExt;
 use crate::prelude::CancellableExtManual;
 use crate::AsyncInitable;
 use crate::AsyncResult;