gio/auto/proxy_resolver.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 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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
// 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, AsyncResult, Cancellable};
use glib::{prelude::*, translate::*};
use std::{boxed::Box as Box_, pin::Pin};
glib::wrapper! {
/// `GProxyResolver` provides synchronous and asynchronous network proxy
/// resolution. `GProxyResolver` is used within [`SocketClient`][crate::SocketClient] through
/// the method [`SocketConnectableExt::proxy_enumerate()`][crate::prelude::SocketConnectableExt::proxy_enumerate()].
///
/// Implementations of `GProxyResolver` based on
/// [libproxy](https://github.com/libproxy/libproxy) and GNOME settings can be
/// found in [glib-networking](https://gitlab.gnome.org/GNOME/glib-networking).
/// GIO comes with an implementation for use inside Flatpak portals.
///
/// # Implements
///
/// [`ProxyResolverExt`][trait@crate::prelude::ProxyResolverExt]
#[doc(alias = "GProxyResolver")]
pub struct ProxyResolver(Interface<ffi::GProxyResolver, ffi::GProxyResolverInterface>);
match fn {
type_ => || ffi::g_proxy_resolver_get_type(),
}
}
impl ProxyResolver {
pub const NONE: Option<&'static ProxyResolver> = None;
/// Gets the default #GProxyResolver for the system.
///
/// # Returns
///
/// the default #GProxyResolver, which
/// will be a dummy object if no proxy resolver is available
#[doc(alias = "g_proxy_resolver_get_default")]
#[doc(alias = "get_default")]
#[allow(clippy::should_implement_trait)]
pub fn default() -> ProxyResolver {
unsafe { from_glib_none(ffi::g_proxy_resolver_get_default()) }
}
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::ProxyResolver>> Sealed for T {}
}
/// Trait containing all [`struct@ProxyResolver`] methods.
///
/// # Implementors
///
/// [`ProxyResolver`][struct@crate::ProxyResolver], [`SimpleProxyResolver`][struct@crate::SimpleProxyResolver]
pub trait ProxyResolverExt: IsA<ProxyResolver> + sealed::Sealed + 'static {
/// Checks if @self can be used on this system. (This is used
/// internally; g_proxy_resolver_get_default() will only return a proxy
/// resolver that returns [`true`] for this method.)
///
/// # Returns
///
/// [`true`] if @self is supported.
#[doc(alias = "g_proxy_resolver_is_supported")]
fn is_supported(&self) -> bool {
unsafe {
from_glib(ffi::g_proxy_resolver_is_supported(
self.as_ref().to_glib_none().0,
))
}
}
/// Looks into the system proxy configuration to determine what proxy,
/// if any, to use to connect to @uri. The returned proxy URIs are of
/// the form `<protocol>://[user[:password]@]host[:port]` or
/// `direct://`, where `<protocol>` could be http, rtsp, socks
/// or other proxying protocol.
///
/// If you don't know what network protocol is being used on the
/// socket, you should use `none` as the URI protocol.
/// In this case, the resolver might still return a generic proxy type
/// (such as SOCKS), but would not return protocol-specific proxy types
/// (such as http).
///
/// `direct://` is used when no proxy is needed.
/// Direct connection should not be attempted unless it is part of the
/// returned array of proxies.
/// ## `uri`
/// a URI representing the destination to connect to
/// ## `cancellable`
/// a #GCancellable, or [`None`]
///
/// # Returns
///
/// A
/// NULL-terminated array of proxy URIs. Must be freed
/// with g_strfreev().
#[doc(alias = "g_proxy_resolver_lookup")]
fn lookup(
&self,
uri: &str,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<Vec<glib::GString>, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_proxy_resolver_lookup(
self.as_ref().to_glib_none().0,
uri.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more
/// details.
/// ## `uri`
/// a URI representing the destination to connect to
/// ## `cancellable`
/// a #GCancellable, or [`None`]
/// ## `callback`
/// callback to call after resolution completes
#[doc(alias = "g_proxy_resolver_lookup_async")]
fn lookup_async<P: FnOnce(Result<Vec<glib::GString>, glib::Error>) + 'static>(
&self,
uri: &str,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn lookup_async_trampoline<
P: FnOnce(Result<Vec<glib::GString>, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret =
ffi::g_proxy_resolver_lookup_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(FromGlibPtrContainer::from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = lookup_async_trampoline::<P>;
unsafe {
ffi::g_proxy_resolver_lookup_async(
self.as_ref().to_glib_none().0,
uri.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn lookup_future(
&self,
uri: &str,
) -> Pin<
Box_<dyn std::future::Future<Output = Result<Vec<glib::GString>, glib::Error>> + 'static>,
> {
let uri = String::from(uri);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.lookup_async(&uri, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
}
impl<O: IsA<ProxyResolver>> ProxyResolverExt for O {}