gio/auto/

proxy.rs

// 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, IOStream, ProxyAddress};
use glib::{prelude::*, translate::*};
use std::{boxed::Box as Box_, pin::Pin};

glib::wrapper! {
    /// A `GProxy` handles connecting to a remote host via a given type of
    /// proxy server. It is implemented by the `gio-proxy` extension point.
    /// The extensions are named after their proxy protocol name. As an
    /// example, a SOCKS5 proxy implementation can be retrieved with the
    /// name `socks5` using the function
    /// [`IOExtensionPoint::extension_by_name()`][crate::IOExtensionPoint::extension_by_name()].
    ///
    /// # Implements
    ///
    /// [`ProxyExt`][trait@crate::prelude::ProxyExt]
    #[doc(alias = "GProxy")]
    pub struct Proxy(Interface<ffi::GProxy, ffi::GProxyInterface>);

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

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

    /// Find the `gio-proxy` extension point for a proxy implementation that supports
    /// the specified protocol.
    /// ## `protocol`
    /// the proxy protocol name (e.g. http, socks, etc)
    ///
    /// # Returns
    ///
    /// return a #GProxy or NULL if protocol
    ///               is not supported.
    #[doc(alias = "g_proxy_get_default_for_protocol")]
    #[doc(alias = "get_default_for_protocol")]
    pub fn default_for_protocol(protocol: &str) -> Option<Proxy> {
        unsafe {
            from_glib_full(ffi::g_proxy_get_default_for_protocol(
                protocol.to_glib_none().0,
            ))
        }
    }
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::Proxy>> Sealed for T {}
}

/// Trait containing all [`struct@Proxy`] methods.
///
/// # Implementors
///
/// [`Proxy`][struct@crate::Proxy]
pub trait ProxyExt: IsA<Proxy> + sealed::Sealed + 'static {
    /// Given @connection to communicate with a proxy (eg, a
    /// #GSocketConnection that is connected to the proxy server), this
    /// does the necessary handshake to connect to @proxy_address, and if
    /// required, wraps the #GIOStream to handle proxy payload.
    /// ## `connection`
    /// a #GIOStream
    /// ## `proxy_address`
    /// a #GProxyAddress
    /// ## `cancellable`
    /// a #GCancellable
    ///
    /// # Returns
    ///
    /// a #GIOStream that will replace @connection. This might
    ///               be the same as @connection, in which case a reference
    ///               will be added.
    #[doc(alias = "g_proxy_connect")]
    fn connect(
        &self,
        connection: &impl IsA<IOStream>,
        proxy_address: &impl IsA<ProxyAddress>,
        cancellable: Option<&impl IsA<Cancellable>>,
    ) -> Result<IOStream, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::g_proxy_connect(
                self.as_ref().to_glib_none().0,
                connection.as_ref().to_glib_none().0,
                proxy_address.as_ref().to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Asynchronous version of g_proxy_connect().
    /// ## `connection`
    /// a #GIOStream
    /// ## `proxy_address`
    /// a #GProxyAddress
    /// ## `cancellable`
    /// a #GCancellable
    /// ## `callback`
    /// a #GAsyncReadyCallback
    #[doc(alias = "g_proxy_connect_async")]
    fn connect_async<P: FnOnce(Result<IOStream, glib::Error>) + 'static>(
        &self,
        connection: &impl IsA<IOStream>,
        proxy_address: &impl IsA<ProxyAddress>,
        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 connect_async_trampoline<
            P: FnOnce(Result<IOStream, 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_connect_finish(_source_object as *mut _, res, &mut error);
            let result = if error.is_null() {
                Ok(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 = connect_async_trampoline::<P>;
        unsafe {
            ffi::g_proxy_connect_async(
                self.as_ref().to_glib_none().0,
                connection.as_ref().to_glib_none().0,
                proxy_address.as_ref().to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                Some(callback),
                Box_::into_raw(user_data) as *mut _,
            );
        }
    }

    fn connect_future(
        &self,
        connection: &(impl IsA<IOStream> + Clone + 'static),
        proxy_address: &(impl IsA<ProxyAddress> + Clone + 'static),
    ) -> Pin<Box_<dyn std::future::Future<Output = Result<IOStream, glib::Error>> + 'static>> {
        let connection = connection.clone();
        let proxy_address = proxy_address.clone();
        Box_::pin(crate::GioFuture::new(
            self,
            move |obj, cancellable, send| {
                obj.connect_async(&connection, &proxy_address, Some(cancellable), move |res| {
                    send.resolve(res);
                });
            },
        ))
    }

    /// Some proxy protocols expect to be passed a hostname, which they
    /// will resolve to an IP address themselves. Others, like SOCKS4, do
    /// not allow this. This function will return [`false`] if @self is
    /// implementing such a protocol. When [`false`] is returned, the caller
    /// should resolve the destination hostname first, and then pass a
    /// #GProxyAddress containing the stringified IP address to
    /// g_proxy_connect() or g_proxy_connect_async().
    ///
    /// # Returns
    ///
    /// [`true`] if hostname resolution is supported.
    #[doc(alias = "g_proxy_supports_hostname")]
    fn supports_hostname(&self) -> bool {
        unsafe {
            from_glib(ffi::g_proxy_supports_hostname(
                self.as_ref().to_glib_none().0,
            ))
        }
    }
}

impl<O: IsA<Proxy>> ProxyExt for O {}