gio/auto/
unix_fd_list.rs

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
// 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! {
    /// A `GUnixFDList` contains a list of file descriptors.  It owns the file
    /// descriptors that it contains, closing them when finalized.
    ///
    /// It may be wrapped in a
    /// [`GUnixFDMessage`](../gio-unix/class.UnixFDMessage.html) and sent over a
    /// [`Socket`][crate::Socket] in the `G_SOCKET_FAMILY_UNIX` family by using
    /// [`SocketExtManual::send_message()`][crate::prelude::SocketExtManual::send_message()] and received using
    /// [`SocketExtManual::receive_message()`][crate::prelude::SocketExtManual::receive_message()].
    ///
    /// Before 2.74, `<gio/gunixfdlist.h>` belonged to the UNIX-specific GIO
    /// interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file when
    /// using it.
    ///
    /// Since 2.74, the API is available for Windows.
    ///
    /// # Implements
    ///
    /// [`UnixFDListExt`][trait@crate::prelude::UnixFDListExt], [`trait@glib::ObjectExt`], [`UnixFDListExtManual`][trait@crate::prelude::UnixFDListExtManual]
    #[doc(alias = "GUnixFDList")]
    pub struct UnixFDList(Object<ffi::GUnixFDList, ffi::GUnixFDListClass>);

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

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

    /// Creates a new #GUnixFDList containing no file descriptors.
    ///
    /// # Returns
    ///
    /// a new #GUnixFDList
    #[doc(alias = "g_unix_fd_list_new")]
    pub fn new() -> UnixFDList {
        unsafe { from_glib_full(ffi::g_unix_fd_list_new()) }
    }
}

impl Default for UnixFDList {
    fn default() -> Self {
        Self::new()
    }
}

/// Trait containing all [`struct@UnixFDList`] methods.
///
/// # Implementors
///
/// [`UnixFDList`][struct@crate::UnixFDList]
pub trait UnixFDListExt: IsA<UnixFDList> + 'static {
    /// Gets the length of @self (ie: the number of file descriptors
    /// contained within).
    ///
    /// # Returns
    ///
    /// the length of @self
    #[doc(alias = "g_unix_fd_list_get_length")]
    #[doc(alias = "get_length")]
    fn length(&self) -> i32 {
        unsafe { ffi::g_unix_fd_list_get_length(self.as_ref().to_glib_none().0) }
    }
}

impl<O: IsA<UnixFDList>> UnixFDListExt for O {}