Merge pull request #915 from jf2048/file-descriptor-based

gio: bind GFileDescriptorBased

Author: sdroege

gio/Gir.toml

@@ -783,6 +783,12 @@ status = "generate"
     # Better API with `IntoIter`
     ignore = true
 
+[[object]]
+name = "Gio.FileDescriptorBased"
+status = "manual"
+cfg_condition = "unix"
+manual_traits = ["FileDescriptorBasedExtManual"]
+
 [[object]]
 name = "Gio.FileEnumerator"
 status = "generate"
@@ -1480,9 +1486,8 @@ manual_traits = ["UnixInputStreamExtManual"]
 
     [[object.function]]
     name = "get_fd"
-    # has to use RawFd
-    manual = true
-    doc_trait_name = "UnixInputStreamExtManual"
+    # conflicts with as FileDescriptorBased::fd
+    ignore = true
 
     [[object.property]]
     name = "fd"
@@ -1551,9 +1556,8 @@ manual_traits = ["UnixOutputStreamExtManual"]
 
     [[object.function]]
     name = "get_fd"
-    # has to use RawFd
-    manual = true
-    doc_trait_name = "UnixOutputStreamExtManual"
+    # conflicts with as FileDescriptorBased::fd
+    ignore = true
 
     [[object.property]]
     name = "fd"

gio/src/auto/unix_input_stream.rs

@@ -2,13 +2,13 @@
 // from gir-files (https://github.com/gtk-rs/gir-files)
 // DO NOT EDIT
 
-use crate::{InputStream, PollableInputStream};
+use crate::{FileDescriptorBased, InputStream, PollableInputStream};
 use glib::{prelude::*, translate::*};
 use std::fmt;
 
 glib::wrapper! {
     #[doc(alias = "GUnixInputStream")]
-    pub struct UnixInputStream(Object<ffi::GUnixInputStream, ffi::GUnixInputStreamClass>) @extends InputStream, @implements PollableInputStream;
+    pub struct UnixInputStream(Object<ffi::GUnixInputStream, ffi::GUnixInputStreamClass>) @extends InputStream, @implements FileDescriptorBased, PollableInputStream;
 
     match fn {
         type_ => || ffi::g_unix_input_stream_get_type(),

gio/src/auto/unix_output_stream.rs

@@ -2,13 +2,13 @@
 // from gir-files (https://github.com/gtk-rs/gir-files)
 // DO NOT EDIT
 
-use crate::{OutputStream, PollableOutputStream};
+use crate::{FileDescriptorBased, OutputStream, PollableOutputStream};
 use glib::{prelude::*, translate::*};
 use std::fmt;
 
 glib::wrapper! {
     #[doc(alias = "GUnixOutputStream")]
-    pub struct UnixOutputStream(Object<ffi::GUnixOutputStream, ffi::GUnixOutputStreamClass>) @extends OutputStream, @implements PollableOutputStream;
+    pub struct UnixOutputStream(Object<ffi::GUnixOutputStream, ffi::GUnixOutputStreamClass>) @extends OutputStream, @implements FileDescriptorBased, PollableOutputStream;
 
     match fn {
         type_ => || ffi::g_unix_output_stream_get_type(),

gio/src/file_descriptor_based.rs

@@ -0,0 +1,50 @@
+// Take a look at the license at the top of the repository in the LICENSE file.
+
+#[cfg(unix)]
+use std::os::unix::io::{AsRawFd, FromRawFd, RawFd};
+
+use glib::{prelude::*, translate::*};
+#[cfg(all(not(unix), feature = "dox"))]
+use socket::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
+use std::fmt;
+
+glib::wrapper! {
+    #[doc(alias = "GFileDescriptorBased")]
+    pub struct FileDescriptorBased(Interface<ffi::GFileDescriptorBased, ffi::GFileDescriptorBasedIface>);
+
+    match fn {
+        type_ => || ffi::g_file_descriptor_based_get_type(),
+    }
+}
+
+impl FileDescriptorBased {
+    pub const NONE: Option<&'static FileDescriptorBased> = None;
+}
+
+impl AsRawFd for FileDescriptorBased {
+    fn as_raw_fd(&self) -> RawFd {
+        unsafe { ffi::g_file_descriptor_based_get_fd(self.to_glib_none().0) as _ }
+    }
+}
+
+pub trait FileDescriptorBasedExtManual: 'static {
+    #[doc(alias = "g_file_descriptor_based_get_fd")]
+    #[doc(alias = "get_fd")]
+    fn fd<T: FromRawFd>(&self) -> T;
+}
+
+impl<O: IsA<FileDescriptorBased>> FileDescriptorBasedExtManual for O {
+    fn fd<T: FromRawFd>(&self) -> T {
+        unsafe {
+            T::from_raw_fd(ffi::g_file_descriptor_based_get_fd(
+                self.as_ref().to_glib_none().0,
+            ))
+        }
+    }
+}
+
+impl fmt::Display for FileDescriptorBased {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        f.write_str("FileDescriptorBased")
+    }
+}

gio/src/lib.rs

@@ -47,6 +47,10 @@ pub use crate::file_attribute_info::FileAttributeInfo;
 mod file_attribute_info_list;
 mod file_attribute_matcher;
 pub use crate::file_attribute_matcher::FileAttributematcherIter;
+#[cfg(any(unix, feature = "dox"))]
+mod file_descriptor_based;
+#[cfg(any(unix, feature = "dox"))]
+pub use file_descriptor_based::FileDescriptorBased;
 mod file_enumerator;
 mod file_info;
 mod flags;

gio/src/prelude.rs

@@ -15,6 +15,8 @@ pub use crate::debug_controller_dbus::DebugControllerDBusExtManual;
 #[cfg(any(all(not(windows), not(target_os = "macos")), feature = "dox"))]
 pub use crate::desktop_app_info::DesktopAppInfoExtManual;
 #[cfg(any(unix, feature = "dox"))]
+pub use crate::file_descriptor_based::FileDescriptorBasedExtManual;
+#[cfg(any(unix, feature = "dox"))]
 pub use crate::unix_fd_list::UnixFDListExtManual;
 #[cfg(any(unix, feature = "dox"))]
 pub use crate::unix_fd_message::UnixFDMessageExtManual;

gio/src/unix_input_stream.rs

@@ -1,11 +1,11 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #[cfg(unix)]
-use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
+use std::os::unix::io::{AsRawFd, IntoRawFd, RawFd};
 
 use glib::{prelude::*, translate::*};
 #[cfg(all(not(unix), feature = "dox"))]
-use socket::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
+use socket::{AsRawFd, IntoRawFd, RawFd};
 
 use crate::{InputStream, UnixInputStream};
 
@@ -44,10 +44,6 @@ impl AsRawFd for UnixInputStream {
 }
 
 pub trait UnixInputStreamExtManual: Sized {
-    #[doc(alias = "g_unix_input_stream_get_fd")]
-    #[doc(alias = "get_fd")]
-    fn fd<T: FromRawFd>(&self) -> T;
-
     // rustdoc-stripper-ignore-next
     /// Sets whether the fd of this stream will be closed when the stream is closed.
     ///
@@ -59,14 +55,6 @@ pub trait UnixInputStreamExtManual: Sized {
 }
 
 impl<O: IsA<UnixInputStream>> UnixInputStreamExtManual for O {
-    fn fd<T: FromRawFd>(&self) -> T {
-        unsafe {
-            T::from_raw_fd(ffi::g_unix_input_stream_get_fd(
-                self.as_ref().to_glib_none().0,
-            ))
-        }
-    }
-
     unsafe fn set_close_fd(&self, close_fd: bool) {
         ffi::g_unix_input_stream_set_close_fd(self.as_ref().to_glib_none().0, close_fd.into_glib());
     }

gio/src/unix_output_stream.rs

@@ -1,11 +1,11 @@
 // Take a look at the license at the top of the repository in the LICENSE file.
 
 #[cfg(unix)]
-use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
+use std::os::unix::io::{AsRawFd, IntoRawFd, RawFd};
 
 use glib::{prelude::*, translate::*};
 #[cfg(all(not(unix), feature = "dox"))]
-use socket::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
+use socket::{AsRawFd, IntoRawFd, RawFd};
 
 use crate::{OutputStream, UnixOutputStream};
 
@@ -44,10 +44,6 @@ impl AsRawFd for UnixOutputStream {
 }
 
 pub trait UnixOutputStreamExtManual: Sized {
-    #[doc(alias = "g_unix_output_stream_get_fd")]
-    #[doc(alias = "get_fd")]
-    fn fd<T: FromRawFd>(&self) -> T;
-
     // rustdoc-stripper-ignore-next
     /// Sets whether the fd of this stream will be closed when the stream is closed.
     ///
@@ -59,14 +55,6 @@ pub trait UnixOutputStreamExtManual: Sized {
 }
 
 impl<O: IsA<UnixOutputStream>> UnixOutputStreamExtManual for O {
-    fn fd<T: FromRawFd>(&self) -> T {
-        unsafe {
-            T::from_raw_fd(ffi::g_unix_output_stream_get_fd(
-                self.as_ref().to_glib_none().0,
-            ))
-        }
-    }
-
     unsafe fn set_close_fd(&self, close_fd: bool) {
         ffi::g_unix_output_stream_set_close_fd(
             self.as_ref().to_glib_none().0,