gio/auto/

simple_proxy_resolver.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, ProxyResolver};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// `GSimpleProxyResolver` is a simple [`ProxyResolver`][crate::ProxyResolver] implementation
    /// that handles a single default proxy, multiple URI-scheme-specific
    /// proxies, and a list of hosts that proxies should not be used for.
    ///
    /// `GSimpleProxyResolver` is never the default proxy resolver, but it
    /// can be used as the base class for another proxy resolver
    /// implementation, or it can be created and used manually, such as
    /// with [`SocketClientExt::set_proxy_resolver()`][crate::prelude::SocketClientExt::set_proxy_resolver()].
    ///
    /// ## Properties
    ///
    ///
    /// #### `default-proxy`
    ///  The default proxy URI that will be used for any URI that doesn't
    /// match #GSimpleProxyResolver:ignore-hosts, and doesn't match any
    /// of the schemes set with g_simple_proxy_resolver_set_uri_proxy().
    ///
    /// Note that as a special case, if this URI starts with
    /// "socks://", #GSimpleProxyResolver will treat it as referring
    /// to all three of the socks5, socks4a, and socks4 proxy types.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `ignore-hosts`
    ///  A list of hostnames and IP addresses that the resolver should
    /// allow direct connections to.
    ///
    /// Entries can be in one of 4 formats:
    ///
    /// - A hostname, such as "example.com", ".example.com", or
    ///   "*.example.com", any of which match "example.com" or
    ///   any subdomain of it.
    ///
    /// - An IPv4 or IPv6 address, such as "192.168.1.1",
    ///   which matches only that address.
    ///
    /// - A hostname or IP address followed by a port, such as
    ///   "example.com:80", which matches whatever the hostname or IP
    ///   address would match, but only for URLs with the (explicitly)
    ///   indicated port. In the case of an IPv6 address, the address
    ///   part must appear in brackets: "[::1]:443"
    ///
    /// - An IP address range, given by a base address and prefix length,
    ///   such as "fe80::/10", which matches any address in that range.
    ///
    /// Note that when dealing with Unicode hostnames, the matching is
    /// done against the ASCII form of the name.
    ///
    /// Also note that hostname exclusions apply only to connections made
    /// to hosts identified by name, and IP address exclusions apply only
    /// to connections made to hosts identified by address. That is, if
    /// example.com has an address of 192.168.1.1, and the :ignore-hosts list
    /// contains only "192.168.1.1", then a connection to "example.com"
    /// (eg, via a #GNetworkAddress) will use the proxy, and a connection to
    /// "192.168.1.1" (eg, via a #GInetSocketAddress) will not.
    ///
    /// These rules match the "ignore-hosts"/"noproxy" rules most
    /// commonly used by other applications.
    ///
    /// Readable | Writeable
    ///
    /// # Implements
    ///
    /// [`SimpleProxyResolverExt`][trait@crate::prelude::SimpleProxyResolverExt], [`trait@glib::ObjectExt`], [`ProxyResolverExt`][trait@crate::prelude::ProxyResolverExt], [`SimpleProxyResolverExtManual`][trait@crate::prelude::SimpleProxyResolverExtManual]
    #[doc(alias = "GSimpleProxyResolver")]
    pub struct SimpleProxyResolver(Object<ffi::GSimpleProxyResolver, ffi::GSimpleProxyResolverClass>) @implements ProxyResolver;

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

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

/// Trait containing all [`struct@SimpleProxyResolver`] methods.
///
/// # Implementors
///
/// [`SimpleProxyResolver`][struct@crate::SimpleProxyResolver]
pub trait SimpleProxyResolverExt: IsA<SimpleProxyResolver> + 'static {
    /// Sets the default proxy on @self, to be used for any URIs that
    /// don't match #GSimpleProxyResolver:ignore-hosts or a proxy set
    /// via g_simple_proxy_resolver_set_uri_proxy().
    ///
    /// If @default_proxy starts with "socks://",
    /// #GSimpleProxyResolver will treat it as referring to all three of
    /// the socks5, socks4a, and socks4 proxy types.
    /// ## `default_proxy`
    /// the default proxy to use
    #[doc(alias = "g_simple_proxy_resolver_set_default_proxy")]
    #[doc(alias = "default-proxy")]
    fn set_default_proxy(&self, default_proxy: Option<&str>) {
        unsafe {
            ffi::g_simple_proxy_resolver_set_default_proxy(
                self.as_ref().to_glib_none().0,
                default_proxy.to_glib_none().0,
            );
        }
    }

    /// Adds a URI-scheme-specific proxy to @self; URIs whose scheme
    /// matches @uri_scheme (and which don't match
    /// #GSimpleProxyResolver:ignore-hosts) will be proxied via @proxy.
    ///
    /// As with #GSimpleProxyResolver:default-proxy, if @proxy starts with
    /// "socks://", #GSimpleProxyResolver will treat it
    /// as referring to all three of the socks5, socks4a, and socks4 proxy
    /// types.
    /// ## `uri_scheme`
    /// the URI scheme to add a proxy for
    /// ## `proxy`
    /// the proxy to use for @uri_scheme
    #[doc(alias = "g_simple_proxy_resolver_set_uri_proxy")]
    fn set_uri_proxy(&self, uri_scheme: &str, proxy: &str) {
        unsafe {
            ffi::g_simple_proxy_resolver_set_uri_proxy(
                self.as_ref().to_glib_none().0,
                uri_scheme.to_glib_none().0,
                proxy.to_glib_none().0,
            );
        }
    }

    /// The default proxy URI that will be used for any URI that doesn't
    /// match #GSimpleProxyResolver:ignore-hosts, and doesn't match any
    /// of the schemes set with g_simple_proxy_resolver_set_uri_proxy().
    ///
    /// Note that as a special case, if this URI starts with
    /// "socks://", #GSimpleProxyResolver will treat it as referring
    /// to all three of the socks5, socks4a, and socks4 proxy types.
    #[doc(alias = "default-proxy")]
    fn default_proxy(&self) -> Option<glib::GString> {
        ObjectExt::property(self.as_ref(), "default-proxy")
    }

    /// A list of hostnames and IP addresses that the resolver should
    /// allow direct connections to.
    ///
    /// Entries can be in one of 4 formats:
    ///
    /// - A hostname, such as "example.com", ".example.com", or
    ///   "*.example.com", any of which match "example.com" or
    ///   any subdomain of it.
    ///
    /// - An IPv4 or IPv6 address, such as "192.168.1.1",
    ///   which matches only that address.
    ///
    /// - A hostname or IP address followed by a port, such as
    ///   "example.com:80", which matches whatever the hostname or IP
    ///   address would match, but only for URLs with the (explicitly)
    ///   indicated port. In the case of an IPv6 address, the address
    ///   part must appear in brackets: "[::1]:443"
    ///
    /// - An IP address range, given by a base address and prefix length,
    ///   such as "fe80::/10", which matches any address in that range.
    ///
    /// Note that when dealing with Unicode hostnames, the matching is
    /// done against the ASCII form of the name.
    ///
    /// Also note that hostname exclusions apply only to connections made
    /// to hosts identified by name, and IP address exclusions apply only
    /// to connections made to hosts identified by address. That is, if
    /// example.com has an address of 192.168.1.1, and the :ignore-hosts list
    /// contains only "192.168.1.1", then a connection to "example.com"
    /// (eg, via a #GNetworkAddress) will use the proxy, and a connection to
    /// "192.168.1.1" (eg, via a #GInetSocketAddress) will not.
    ///
    /// These rules match the "ignore-hosts"/"noproxy" rules most
    /// commonly used by other applications.
    #[doc(alias = "ignore-hosts")]
    fn ignore_hosts(&self) -> Vec<glib::GString> {
        ObjectExt::property(self.as_ref(), "ignore-hosts")
    }

    #[doc(alias = "default-proxy")]
    fn connect_default_proxy_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_default_proxy_trampoline<
            P: IsA<SimpleProxyResolver>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GSimpleProxyResolver,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(SimpleProxyResolver::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::default-proxy\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_default_proxy_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "ignore-hosts")]
    fn connect_ignore_hosts_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_ignore_hosts_trampoline<
            P: IsA<SimpleProxyResolver>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GSimpleProxyResolver,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(SimpleProxyResolver::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::ignore-hosts\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_ignore_hosts_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<SimpleProxyResolver>> SimpleProxyResolverExt for O {}