gio/auto/
socket_connectable.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
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
// 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, SocketAddressEnumerator};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// Objects that describe one or more potential socket endpoints
    /// implement `GSocketConnectable`. Callers can then use
    /// [`SocketConnectableExt::enumerate()`][crate::prelude::SocketConnectableExt::enumerate()] to get a
    /// [`SocketAddressEnumerator`][crate::SocketAddressEnumerator] to try out each socket address in turn
    /// until one succeeds, as shown in the sample code below.
    ///
    /// **⚠️ The following code is in c ⚠️**
    ///
    /// ```c
    /// MyConnectionType *
    /// connect_to_host (const char    *hostname,
    ///                  guint16        port,
    ///                  GCancellable  *cancellable,
    ///                  GError       **error)
    /// {
    ///   MyConnection *conn = NULL;
    ///   GSocketConnectable *addr;
    ///   GSocketAddressEnumerator *enumerator;
    ///   GSocketAddress *sockaddr;
    ///   GError *conn_error = NULL;
    ///
    ///   addr = g_network_address_new (hostname, port);
    ///   enumerator = g_socket_connectable_enumerate (addr);
    ///   g_object_unref (addr);
    ///
    ///   // Try each sockaddr until we succeed. Record the first connection error,
    ///   // but not any further ones (since they'll probably be basically the same
    ///   // as the first).
    ///   while (!conn && (sockaddr = g_socket_address_enumerator_next (enumerator, cancellable, error))
    ///     {
    ///       conn = connect_to_sockaddr (sockaddr, conn_error ? NULL : &conn_error);
    ///       g_object_unref (sockaddr);
    ///     }
    ///   g_object_unref (enumerator);
    ///
    ///   if (conn)
    ///     {
    ///       if (conn_error)
    ///         {
    ///           // We couldn't connect to the first address, but we succeeded
    ///           // in connecting to a later address.
    ///           g_error_free (conn_error);
    ///         }
    ///       return conn;
    ///     }
    ///   else if (error)
    ///     {
    ///       /// Either initial lookup failed, or else the caller cancelled us.
    ///       if (conn_error)
    ///         g_error_free (conn_error);
    ///       return NULL;
    ///     }
    ///   else
    ///     {
    ///       g_error_propagate (error, conn_error);
    ///       return NULL;
    ///     }
    /// }
    /// ```
    ///
    /// # Implements
    ///
    /// [`SocketConnectableExt`][trait@crate::prelude::SocketConnectableExt]
    #[doc(alias = "GSocketConnectable")]
    pub struct SocketConnectable(Interface<ffi::GSocketConnectable, ffi::GSocketConnectableIface>);

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

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

/// Trait containing all [`struct@SocketConnectable`] methods.
///
/// # Implementors
///
/// [`InetSocketAddress`][struct@crate::InetSocketAddress], [`NativeSocketAddress`][struct@crate::NativeSocketAddress], [`NetworkAddress`][struct@crate::NetworkAddress], [`NetworkService`][struct@crate::NetworkService], [`ProxyAddress`][struct@crate::ProxyAddress], [`SocketAddress`][struct@crate::SocketAddress], [`SocketConnectable`][struct@crate::SocketConnectable], [`UnixSocketAddress`][struct@crate::UnixSocketAddress]
pub trait SocketConnectableExt: IsA<SocketConnectable> + 'static {
    /// Creates a #GSocketAddressEnumerator for @self.
    ///
    /// # Returns
    ///
    /// a new #GSocketAddressEnumerator.
    #[doc(alias = "g_socket_connectable_enumerate")]
    fn enumerate(&self) -> SocketAddressEnumerator {
        unsafe {
            from_glib_full(ffi::g_socket_connectable_enumerate(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Creates a #GSocketAddressEnumerator for @self that will
    /// return a #GProxyAddress for each of its addresses that you must connect
    /// to via a proxy.
    ///
    /// If @self does not implement
    /// g_socket_connectable_proxy_enumerate(), this will fall back to
    /// calling g_socket_connectable_enumerate().
    ///
    /// # Returns
    ///
    /// a new #GSocketAddressEnumerator.
    #[doc(alias = "g_socket_connectable_proxy_enumerate")]
    fn proxy_enumerate(&self) -> SocketAddressEnumerator {
        unsafe {
            from_glib_full(ffi::g_socket_connectable_proxy_enumerate(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Format a #GSocketConnectable as a string. This is a human-readable format for
    /// use in debugging output, and is not a stable serialization format. It is not
    /// suitable for use in user interfaces as it exposes too much information for a
    /// user.
    ///
    /// If the #GSocketConnectable implementation does not support string formatting,
    /// the implementation’s type name will be returned as a fallback.
    ///
    /// # Returns
    ///
    /// the formatted string
    #[doc(alias = "g_socket_connectable_to_string")]
    fn to_string(&self) -> glib::GString {
        unsafe {
            from_glib_full(ffi::g_socket_connectable_to_string(
                self.as_ref().to_glib_none().0,
            ))
        }
    }
}

impl<O: IsA<SocketConnectable>> SocketConnectableExt for O {}